Changes between Version 11 and Version 12 of CodeDocumentation


Ignore:
Timestamp:
2010-04-04 08:57:18 (9 years ago)
Author:
jeroens
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • CodeDocumentation

    v11 v12  
    11= XML Code Documentation = 
    2 Microsoft Visual Studio allows code documentation to be incorporated in supported sources, which can be compiled via third-party tools into API help files. The structure of source code comments must adhere to the [http://en.wikipedia.org/wiki/Microsoft_Assistance_Markup_Language Windows Assistance Markup Language (MAML)] standard. This section explains how to generate EwE6 API help files from the EwE6 source code projects. 
     2Microsoft Visual Studio allows developers to write source code documentation, which can be compiled via third-party tools into API help files. This section explains how to generate EwE6 API help files from the EwE6 source code projects. 
    33 
    4 In the past we used [http://en.wikipedia.org/wiki/NDoc NDoc] to create API documentation of our sources. The NDoc project has been abandoned in 2007, but thankfully Microsoft supports a tool called '[http://en.wikipedia.org/wiki/Sandcastle_(software) Sandcastle]'. 
     4In the past, we used [http://en.wikipedia.org/wiki/NDoc NDoc] to create API documentation of our sources. The NDoc project has been abandoned in 2007, but thankfully Microsoft supports a tool called '[http://en.wikipedia.org/wiki/Sandcastle_(software) Sandcastle]'. 
    55 
    66 * Download and install Sandcastle [http://www.microsoft.com/downloads/details.aspx?familyid=E82EA71D-DA89-42EE-A715-696E3A4873B2&displaylang=en here] 
     
    1616 
    1717= Links =  
    18 Lots of information is available on XML tags supported in Visual Studio. A few comprehensive links are: 
     18Whether you write your own code, extend or hijack the Ecopath sources for illegitimate purposes, you may want to add code documentation of your own. Lots of information is available on XML tags supported in Visual Studio. A few comprehensive links are: 
     19 * [http://en.wikipedia.org/wiki/Microsoft_Assistance_Markup_Language Windows Assistance Markup Language (MAML)] - XML standard that defines the source code comments structure. 
    1920 * [http://msdn.microsoft.com/en-us/magazine/cc302121.aspx XML comments overview] - Microsoft XML comments primer in C# syntax, with detailed info on sub-tags such as <list type="...">. A good read. 
    2021 * [http://www.codeproject.com/KB/XML/csharpcodedocumentation.aspx XML comments guidelines] - XML comments usage guidelines