Need a Tech. info sample/standart on the application product
-
Hi all, Our firm is in search for the standart/sample on documenting the program product. I mean technical documentation, such as module descriptions, functions, variables etc. Can anyone recommend some links ? Thanks in advance, Valery P.S. It is late to drink mineral water when the liver fall off, I understand :)
-
Hi all, Our firm is in search for the standart/sample on documenting the program product. I mean technical documentation, such as module descriptions, functions, variables etc. Can anyone recommend some links ? Thanks in advance, Valery P.S. It is late to drink mineral water when the liver fall off, I understand :)
Before you come up with a code documentation standard, you need to decide how you're going to the the documentation out of it. Tools such as DoxyGen and Cocoon http://www.stratasys.com/software/cocoon/[^] have radically different formatting requirements. None are difficult, just different. If you're using .Net there is an XML commenting tool built in. See http://msdn.microsoft.com/library/default.asp?url=/library/en-us/vsintro7/html/vxconCommentingCode.asp[^]