You are here:
Vanderbilt Biostatistics Wiki
>
Main Web
>
Projects
>
MicroArrayMassSpec
>
GeneralWfccmDesign
>
WfccmCommentingGuidelines
(revision 7) (raw view)
Edit
Attach
---+++Commenting Guidelines * Add class/function header at time of creation * Use <summery> to describe the function/class. * Use <remarks> to put other information such as author, creation data, modifications. * Comment all code at time of creation. * Date format: =01 Jan 2004= * Use =// TODO: [notice]= to indicate that more needs to be done here. * Use =// !TODO: [notice]= to indicate that more needs to be done here to alleviate a possible problem. * Surround debug code with =/* debug */= so that others know that it can safely be removed. * Include a file header separate from the xml comments. * Include file name and project name. * Include purpose. * Function/class/file updates: * Include edit date, editor, and edit purpose. * When editing function/class information, use the following structure (Use =<pre></pre>= to preserve formatting): <verbatim> /// <remarks><pre> /// [Edit date] - [Editor] /// - [Edit purpose 1] /// - [Edit purpose 2] /// </pre></remarks> </verbatim> * Use .NET XML comments. * Put three forward slashes on the line before the function for automatic XML summary tags, including relevant param and returns tags. * Use Tools->Build Comment Web Pages... to view documentation for classes. * Turn off incremental build to update XML documentation? * Put the following code between lines 1 and 2 of the XML documentation file after updating. <verbatim> <?xml:stylesheet href="doc.xsl" type="text/xsl"?> </verbatim> * File Header Format: <verbatim> <---------------------90 spaces wide prints very well in Visual Studio-------------------> /***************************************************************************************** * [Author] [File name] * * [Creation date] [Project name] * *****************************************************************************************/ </verbatim> ---+++.NET XML Resources * XML Documentation in C# (whitepaper from http://www.gotdotnet.com) * http://www.gotdotnet.com/team/csharp/learn/whitepapers/XMLDocs.doc * C# Programmer's Reference: XML Documentation * http://msdn.microsoft.com/library/default.asp?url=/library/en-us/csref/html/vcoriXMLDocumentation.asp * XML Comments Let You Build Documentation Directly From Your Visual Studio .NET Source Files * http://msdn.microsoft.com/msdnmag/issues/02/06/XMLC/default.aspx -- Main.JeremyRoberts - 27 Jun 2004<br> -- Main.WillGray - 28 Jun 2004
Edit
|
Attach
|
P
rint version
|
H
istory
:
r12
|
r8
<
r7
<
r6
<
r5
|
B
acklinks
|
V
iew topic
|
Edit WikiText
|
More topic actions...
Topic revision: r7 - 28 Jun 2004,
WillGray
Main
Department Home Page
Biostatistics Graduate Program
Vanderbilt University Medical Center
Main Web
Main Web Home
Search
Recent Changes
Changes
Topic list
Biostatistics Webs
Archive
Main
Sandbox
System
Register
|
Log In
Copyright © 2013-2022 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding Vanderbilt Biostatistics Wiki?
Send feedback