基于markdown的包注释文档

熟悉javadoc的开发可能对package-info.java也有所了解。package-info.java是没有接口,没有类定义的一个java文件,主要是用于描述包信息的。wrdoclet在1.0.3版本中也加入了对package-info.java的处理。在package-info.java中请使用markdown语法进行注释。wrdoclet会使用pegdown处理注释并生成html文件。

例子:

/**
demosite handbook
=======
这是一个demo site。
是给[wrdoclet](https://github.com/WinRoad-NET/wrdoclet)做测试验证用的。
- test1
- test2
    ``` mvn clean install ```
@tag 附录
 */
package net.winroad.Controller;

注意这里的@tag的使用,如果没有任何@tag,则生成的文档默认使用包的全名作为标签。

appdendix.png

利用package-info.java,可以对服务接口文档进行一些补充说明,比如:接口调用的注意事项;列出所有返回码的完整列表等等。

results matching ""

    No results matching ""