为D源代码生成文档的CandyDoc使用方法
既然要学习D语言,
就需要用D语言去写点东西。
?
写东西的话,
一定会用到注释,
当然,对于一些自己整理的工具类,
也有必要导出文档,
方便以后查看。
?
看了D语言的介绍,
DMD编译器本身支持创建文档的参数“-D”,
而且,
文档注释的方法与JavaDoc的方法也比较类似,
所以,很快就可以使用了。
?
但是,
利用DMD生成的文档画面很“傻”,
一点也不活泼,
找到了一个叫“CandyDoc”的工具,
可以结合DMD生成带导航页的文档,
而且,提供了默认的css,
画面也比较好看。
?
下面记录了使用CandyDoc的方法,
以便日后查阅。
?
1、在D源代码中追加文档注释的方法。
http://www.digitalmars.com/d/2.0/ddoc.html
?
注释必须以“/**”开头。
?
常用的一些标记是:
?
注:
有定义class时,
一定要为class写一段文档注释,
否则,
不能将该module中的注释导出为文档。
?
3、CandyDoc的使用
从官网下载CandyDoc。
http://www.dsource.org/projects/helix/wiki/CandyDoc
?
解压缩后,查看CANDYDOC.txt文件,
里面记述了使用方法。
?
我使用了很多的默认theme,
基本没有作什么修改。
?
我准备把文档生成到src\docs中,
所以,目前的目录结构变成了下面这样:
?
?