Everyone has their own preference, so take this for what it's worth, but if I'm building a big comment block to explain a data structure in a program, I usually try to show it without a lot of symbology:
* 001 Some attribute * 002 Something else * 003 List of somethings (cmv) * 004 Dependent list of somethings (dmv) (cmv) = controlling mv (dmv) = dependent mv (csv) = controlling sv (dsv) = dependent sv If it's a work record or something like that being built, EQUs are also a very good way to document the structure, with the parenthetical comments (csv, et al) to illustrate structure. Bottom line, if it's comments, make it as easy to understand six months after the fact as possible, otherwise you may find yourself looking at your program just after Christmas and saying "what the heck is \ again?". -Kevin [EMAIL PROTECTED] http://www.PrecisOnline.com -----Original Message----- From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] On Behalf Of Debster Sent: Tuesday, September 21, 2004 12:35 PM To: [EMAIL PROTECTED] Subject: RE: [U2] Attribute marks in comments? OR... in the comments you can use ] for VM / or \ to indicate a subvalue within -----Original Message----- From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] Behalf Of Barry Brevik Sent: Tuesday, September 21, 2004 1:45 PM To: U2-users (E-mail) Subject: [U2] Attribute marks in comments? Is there a standard or convention for representing attribute marks in program comments? In other words, if I want to document the structure of a dynamic array in a comment, are there single characters that I would use instead of @FM, @VM etc? ------- u2-users mailing list [EMAIL PROTECTED] To unsubscribe please visit http://listserver.u2ug.org/ ------- u2-users mailing list [EMAIL PROTECTED] To unsubscribe please visit http://listserver.u2ug.org/ ------- u2-users mailing list [EMAIL PROTECTED] To unsubscribe please visit http://listserver.u2ug.org/
