Attribute(s)
System Documentation
Description
Each object should contain it's own descriptive comment or documentation.
Motivation
This approach allows for an immediate understanding of the function of the object. Using the Design Synopsis, this documentation is automatically added to the code page. It also facilitates the use of Teamstudio's Teamstudio Analyzer product as a documentation tool.
Example / Details
Each object in the Notes application provides the functionality to include descriptive texts in comment fields or via the inclusion of REM statements. These descriptive texts are part of the technical documentation.Following advantages are identified when descriptive text is stored with objects. The System Developer finds and amends the explanation of the function where he needs it. The descriptive text can be automatically incorporated in the technical documentation with a documentation tool like Teamstudio Analyzer.
The System Developer can use the REM Statement (@REM function in formula language, %REM -%EndRem in LotusScript modules). The REM statement explaining the function should always be placed at the beginning of the function.
The following table indicates where documentation for various design elements can be located in the application:
Design Element
Documentation Location
Forms
Window title
Fields (where explanation is required)
Value or Default Value.
Views and Folders
View Selection Formula Window
Outline
Comment field in object property box
Outline entry
Comment field in object property box
Page
Window title
Frameset
Comment field in object property box
Frame
Formula field of the objext property box
Image resources
Comment field in object property box
Navigators
Navigator Background Formula Window
Agents (@Functions)
Agent Comments.
Agents (Lotus Script)
Every module (function or sub-routine) must start with a REM header
Script Libraries
Every module (function or sub-routine) must start with a REM header