Doc strings for a standalone app??

David Fraser davidf at sjsoft.com
Thu Jun 10 05:43:40 EDT 2004


Roger Binns wrote:
> 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
> 
> 
I use the doc string as the description to give to optparse, so that it 
appears in the command line help...



More information about the Python-list mailing list