Creating developer documentation

posted Dec 4, 2014, 11:52 AM by Lesley Bross
Looking into generating documentation for the Core project(s). It appears to be a 3-step process:
  1. Author code with XML comments and documentation. From a quick perusal of the code, it appears my predecessors have done this for most of the code
  2. Compile the documentation into an XML file. This is as simple as checking a box in the compile properties for the project when using Visual Studio.
  3. Build the documentation into a usable format. This requires a third-party application to read the XML and create a human-readable product. The majority of the resource I've found recommend using an open source project called 'Sandcastle'. I am looking into that.
Resources:
  1. http://gusclass.com/blog/2013/02/25/creating-html-documentation-in-c-using-visual-studio-and-sandcastle/
  2. http://blogs.msdn.com/b/eob/archive/2014/04/22/creating-documentation-in-c-using-visual-studio-and-sandcastle.aspx
  3. Sandcastle project home page: http://shfb.codeplex.com/
Comments