Professional IronPython

Using C# for User Interface Support
 
❘
 
341
Considering Developer Help
As your extensions gain in complexity, you need to start providing some help to the IronPython 
developer. Most IronPython developers will spend part of their time in the interpreter trying things 
out. The developer will look to your documentation for help in using the extension you create. There 
are two forms of help, as shown here.
help(MyDialog.ShowMessage)
MyDialog.ShowMessage.__doc__()
It turns out that IronPython automatically provides a form of the 
help()
function help for you as 
shown in Figure 16-8. In this case, you see all of the method calls that the 
Dialogs
class provides, 
along with the enumeration described in the section “Using Enumerations with IronPython” earlier 
in this chapter.
fIgURE 16-8: 
IronPython provides a kind of help for you automatically.
Unfortunately, IronPython doesn’t provide the 
__doc__()
method by default. You must define it 
for yourself as part of the class you create. Here’s a simple 
__doc__()
method you can use with the 
example. Of course, a production version would contain far more information.
public String __doc__()
{
return “This is a help string”;
}
548592c16.indd 341
2/24/10 12:49:24 PM
www.finebook.ir

---

342
❘
CHAPTER 16
ExtEnding ironPython Using C#
When you try this method out at the Python prompt, you see the outline shown in Figure 16-9. You 
can use all of the normal formatting characters to make the help provided by the 
__doc__()
method 
look nice. For that matter, you could store the information externally and simply read it in as needed.
fIgURE 16-9: 
You must define your own version of the __doc__() method.