Doc strings for a standalone app??

Roger Binns rogerb at rogerbinns.com
Thu Jun 10 03:43:52 CEST 2004


j_mckitrick wrote:
> Does it make sense to use doc strings rather than #-comments for a
> standalone Python app?  If the classes aren't going to be re-used or
> imported, do they need them?

Doc strings are useful for documenting your app :-)

For example if you run epydoc on the code you will get a very good
overview of what is going on.  That is then very useful to other
programmers, or yourself several months later.  And if you ever
sell the code, you'll get a lot more for it :-)

Roger





More information about the Python-list mailing list