Professional IronPython

92
❘
CHAPTER 5
InteractIng wIth StructureS and ObjectS
FIguRE 5-2: 
The simple class outputs the expected information.
Adding Documentation
It’s important to add documentation to your class as soon as possible — preferably while you’re 
typing the code. Many IronPython developers work in the interpreter to create applications faster 
and rely on the 
help()
function or 
__doc__
attribute to understand what a method does with 
considerably less effort than finding the documentation.
Adding documentation to your class is straightforward. You simply add strings immediately after the 
class or method definition. A string that documents your class is called a docstring. IronPython doesn’t 
recognize docstrings that appear in places other than class and method declarations. For example, if 
you place a docstring after an attribute, it won’t appear when you use the 
help()
function or 
__doc__
attribute. However, third-party tools often pick up these additional docstrings and place them in any 
documentation they output. Listing 5-3 shows the example class with docstrings in place.
lISTINg 5-3: 
 Adding documentation to a class
class MyGreetings:
“”“Contains a list of messages that you want to send to the user.
Make sure you assign a value to Name before using any of the 
greetings so the message is customize for that user.”“”
# Greeting name variable.
Name = ‘Sammy’
“”“Provides the user’s name.”“”
# Provides a hello greeting.
def SayHello(self):
“”“Outputs an interesting greeting to the user.”“”
print ‘Hello there’, self.Name, ‘!’
# Provides a goodbye message.
def SayGoodbye(self):
“”“Outputs a goodbye message to the user.”“”
print ‘See you later’, self.Name, ‘!’
Docstrings can consume one or more lines. The standard convention is to place docstrings within 
triple quotes as shown in the listing. You can find a number of other docstring conventions at 
http://www.python.org/dev/peps/pep-0257/
.
548592c05.indd 92
2/24/10 1:21:50 PM
www.finebook.ir

---