Learning Python

Ben Finney bignose+hates-spam at benfinney.id.au
Fri Aug 11 20:52:58 EDT 2006


"Dr. Pastor" <elpX at adsihqX.com> writes:

> #-------------------------------------------------------------------------------
>   # Name:        SendMoreMoney.py
>   # Purpose:     A solution to the SEND+MORE=MONEY puzzle.
>   #
>   # Author:      Dr. Pastor
>   #
>   # Copyright:   (c) Dr. Pastor 2006
>  
> #-------------------------------------------------------------------------------
>   #!/usr/bin/env python

This line, to be at all meaningful, must be the first line in the
file, with no leading spaces.

    <URL:http://en.wikipedia.org/wiki/Shebang_(Unix)>

> #
> # The solution for the puzzle of
> #        SEND
> #       +MORE
> #       -----
> #       MONEY
> #

Somewhat more useful than a comment block to describe your module is a
"doc string" for the module:

    <URL:http://www.python.org/dev/peps/pep-0257/>

You will also thank yourself for writing descriptive doc strings for
each function and class (preferably as soon as you begin writing the
definition, so you don't need to remember to come back later and do
them).

-- 
 \           "Self-respect: The secure feeling that no one, as yet, is |
  `\                                 suspicious."  -- Henry L. Mencken |
_o__)                                                                  |
Ben Finney




More information about the Python-list mailing list