Commenting Guidelines

  • Comment all code at time of creation.
  • Include author and creation date.
    • Date format:   01 Jan 2004
  • Include file name and project name.
  • Include purpose.
  • Updates:
    • Include edit date, editor, and edit purpose.
      • Format:
<---------------------90 spaces wide prints very well in Visual Studio------------------->
/*****************************************************************************************
* [Author]                                                                   [File name] *
* [Creation date]                                                         [Project name] *
*                                                                                        *
* [The overall purpose]                                                                  *
*                                                                                        *
* [Edit date] - [Editor]                                                                 *
*     - [Edit purpose]                                                                   *
*                                                                                        *
* [Edit date] - [Editor]                                                                 *
*     - [Edit purpose 1]                                                                 *
*     - [Edit purpose 2]                                                                 *
*****************************************************************************************/
  • 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.
    • Turn off incremental build to update XML documentation?
    • Put the following code between lines 1 and 2 of the XML documentation file after updating.
<?xml:stylesheet href="doc.xsl" type="text/xsl"?>

.NET XML Resources

-- WillGray - 25 Jun 2004
Edit | Attach | Print version | History: r12 | r4 < r3 < r2 < r1 | Backlinks | View wiki text | Edit WikiText | More topic actions...
Topic revision: r3 - 26 Jun 2004, JeremyRoberts
 

This site is powered by FoswikiCopyright © 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