注释生成Api文档
1.开发背景 最近一直在写dubbo接口,以前总是用word文档写接口描述然后发给别人。现在太多了,而且跟别人对接联调的人家急着用,根本没时间去写word文档。那就想想怎么用doc文档注释 ...
1.开发背景 最近一直在写dubbo接口,以前总是用word文档写接口描述然后发给别人。现在太多了,而且跟别人对接联调的人家急着用,根本没时间去写word文档。那就想想怎么用doc文档注释 ...
注释:注释起到对代码标注和解释的作用,如果你去看看JDK源码,会发现他们有许多的注释,而且注释是比代码还要多的,可见为代码添加注释是非常重要的,写好注释能让别人更加容易看懂你的代码 ...
文档注释是为了方便自己和他人更好地理解代码所实现的功能。下面记录了一些常用的文档注释标记: <C> 用法: <c>text</c> 将说明中的文本标记为代码 ...