Professional IronPython

Understanding the Command Line
 
❘
 
205
Some developers will simply use 
[Options]
 for the command line syntax if you 
can use any of the command line switches at any time, or simply ignore them 
completely. There isn’t anything wrong with this approach, especially when your 
application defaults to showing the help screen when the user doesn’t provide any 
command line switches. However, make absolutely certain that your application 
truly doesn’t have a unique calling syntax before you use this approach.
Documenting the Command Line Switches
No matter how simple or complex the application, you need to document every command line 
switch. Most application writers use anywhere from one to three sentences to document the com-
mand line switch unless it’s truly complex. The command line switch documentation should focus 
on the purpose of the command line switch. Save any examples you want to provide for the usage 
examples portion of the help screen.
You must document every command line switch or the user won’t know it exists. Placing alternative 
command line switches together is a good idea because it reduces the complexity of the help screen. 
The order in which you place the command line switches depends on the purpose and complexity of 
your application. However, most developers use one of the following ordering techniques:
➤➤
Alphabetical: Useful for longer lists of command line switches because alphabetical order can 
make it easier to find a particular command line switch in the list.
➤
➤
Syntactical: Developers especially like to see the command line switches in syntactical order. 
After viewing the syntax, the developer can find the associated command line switch descrip-
tion quickly.
➤
➤