工具:使用过的 API 文档生成工具

背景

2012 年之前几乎没有为代码增加注释,当然,代码的命名也不见得合理(好的代码胜过面面俱到的注释),后来接触过一些开源框架,优秀的框架都有一个特点:文档和示例非常多,在后来的日子里,几乎会强制自己为代码写注释,可能是有点过犹不及了,不过凡事都会经过这个初级阶段,本文总结一下使用过的文档生成工具。

Javascript 文档生成工具

Javascript 这种动态语言更应该写注释。

YUIDoc

网址:http://yui.github.io/yuidoc/。

工具:使用过的 API 文档生成工具_工具

JsDuck

网址:https://github.com/senchalabs/jsduck/wiki。

工具:使用过的 API 文档生成工具_工具_02

C# 文档生成工具

SandCastle

网址:https://sandcastle.codeplex.com/。