|
: 37 : 37 : 0 |
I'd love to see a new "Documentation" object available in the Info List, as shown in the mock-up image, to make it easier to place all our remarks, history, design thoughts, etc. in one spot. Currently we all have different ways to document our code. Some write strings of text in the Options or Declarations area, others insert stuff in the Initialize subroutine, and still others create their own private functions called "VersionInfo," "How_To_Use_This_Library," or "How_It_Works." Sometimes the Help Using/Help About features are employed, other times separate documents are created, and often external files (such as word processing docs or flowcharts) are used. For the majority of my script libs and agents, something as simple as a new "Documentation" object in the Info List would be ideal and would replace all those other choices. Stick it near the top, maybe even at the top, and let us put text (at a minimum) without having to use apostrophes or %REM/%END REM nests. Yeah, there are other ways to skin this furball, but it sure would be convenient to have it all in one place. Plus, exporting it to DXL would bring us much closer to having a really easy way to compile all the documentation with a push of the button, similar to what I've heard about in the Java world (JavaDoc?) If we wanted to expand on the idea, this object could have a few sub-settings or properties, like Version Number (string), Version Date, Designer's Name, Owner/Sponsor's Name, and perhaps even rich text capabilities so we could attach that Visio diagram for the ProcessBeanCounterReports lib directly in the lib itself. It's probably difficult for the IBM guys to do but since they're working in that space anyway (according to Mary Beth Raven at Lotusphere, the nested vertical scroll bars are going away), maybe it's not overly difficult. Maybe the Eclipse environment will make it even easier to accomplish. (NOTE: Terminology references came from "Exploring Lotus Domino Designer" in Designer 6.5.1 Help. I hope I got them right!) |