automated documentation tools

some tools to help automatically generate code/API documentation

Document! X [C# -> docs ]
+ automated documentation and editable templates
+ authoring environment
+ looks better than GhostDoc
- no free option
http://www.innovasys.com/product/dx/overview

GhostDoc [C#/JavaScript -> docs ]
+ can auto generate boilerplate comments
+ can find undocumented code (but only per-file)
+ outputs as Windows help file OR as a web site
+ has a free option
http://submain.com/products/ghostdoc.aspx

docfx [C# -> docs ]
+ free
+ installs via nuget (docfx.msbuild)
+ runs as part of the build
- requires some tinkering to get it working
- default templates need more work (has a copyright Microsoft clause in the output!)
http://vicancy.github.io/docascode/#/tutorial/docfx_getting_started.md
https://www.nuget.org/packages/docfx/

mkdocs [static site from md files]
http://www.mkdocs.org/

SpecFlow + Pickles [spec -> BDD tests -> docs]
http://www.specflow.org/getting-started/
http://docs.picklesdoc.com/en/latest/StartSimple/


Comments