Professional IronPython

Using IronPython Constructively
 
❘
 
93
After you create your docstrings, start the IronPython interpreter and load your class. You can try 
the docstrings out using either the 
help()
function or 
__doc__
attribute. Figure 5-3 shows the
docstring output for the example class.
FIguRE 5-3: 
Docstrings add greatly to the usability of your application.
Self-documenting your application is great, but some people will prefer some sort of HTML docu-
mentation. Don’t worry; you can get a tool to handle this requirement as well. PythonDoc (
http://
effbot.org/zone/pythondoc.htm
) provides the same type of functionality that JavaDoc does. It’s 
akin to generating the documentation you need when you compile your application in Visual Studio. 
PythonDoc locates all of the comments in your code and uses them to create HTML documentation 
that others can use when working with your classes.
uSINg IRoNPyTHoN CoNSTRuCTIVEly
This chapter has helped you discover the objects lurking beneath the surface in IronPython. These 
objects provide a surprising number of features that simply occur automatically. In fact, IronPython 
makes objects look surprisingly simple. Of course, you won’t be happy using just the objects that 
IronPython provides, so this chapter also demonstrates how to create structures and objects of 
your own. The key thing to take from this chapter is not to make structures and objects too hard in 
IronPython — think simple. Otherwise, you’ll end up doing a lot more work than you really need 
to do to make use of objects. More important, your objects might not actually work as you intend if 
you make them too complex (to look like objects you create in other languages).
By now, you should have some interesting ideas for creating objects of your own. Try creating some 
structures and objects in IronPython. In fact, try creating some of both structures and objects to 
ensure you understand the difference between the two. Take time to work with enough objects that 
you understand how they differ from those you create in other languages.
548592c05.indd 93
2/24/10 1:21:50 PM
www.finebook.ir

---