工具:使用過的 API 文檔生成工具


背景

2012 年之前幾乎沒有為代碼增加注釋,當然,代碼的命名也不見得合理(好的代碼勝過面面俱到的注釋),后來接觸過一些開源框架,優秀的框架都有一個特點:文檔和示例非常多,在后來的日子里,幾乎會強制自己為代碼寫注釋,可能是有點過猶不及了,不過凡事都會經過這個初級階段,本文總結一下使用過的文檔生成工具。

Javascript 文檔生成工具

Javascript 這種動態語言更應該寫注釋。

YUIDoc

網址:http://yui.github.io/yuidoc/

JsDuck

網址:https://github.com/senchalabs/jsduck/wiki

C# 文檔生成工具

SandCastle

網址:https://sandcastle.codeplex.com/

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM