Skip to topic
|
Skip to bottom
Jump:
TModeling
TModeling Web
TModeling Web Home
Changes
Notify
Index
Search
Webs
BioGeometry
Main
TModeling
TWiki
Edit
Attach
Printable
TModeling.CommentingPrograms
r1.1 - 19 Jun 2008 - 12:08 - Main.guest
topic end
Start of topic |
Skip to actions
*Commenting Programs* --- * Include a Usage document (Readme) that explains how to use the program via command line paramters, menu commands, keyboard shortcuts, and/or mouse & button gestures * Use a book metaphor for design documents Include a short design document that gives a brief overview of how the program is organized * _Preface_ is the introduction and gives a general overview of the program * _Table of Contents_ shows the top-level files, classes, and routines. For long design documents you can also include * _Chapters_, more detailed information on important files, classes, and routines * _Sections_, overview of each routine, it's parameters, and usage -- Main.ShawnDB - 16 Jun 2008
to top
End of topic
Skip to action links
|
Back to top
Edit
|
Attach image or document
|
Printable version
|
Raw text
|
More topic actions
Revisions: | r1.1
|
Total page history
|
Backlinks
You are here:
TModeling
>
CommentingPrograms
to top
Copyright © 1999-2024 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki?
Send feedback