java 内容 助手 如何制作java帮助手册

我们在开发的过程中，经常需要协作，那么，如果是跨部门或者直接开发底层库的话，能直接提供一套帮助文档是很有必要的。所以整理了一下生成帮助文档的方法。

注释的编写

首先，要有注释的编写，类的，方法的，字段的，注解的……注释其实对自己和对其它人的帮助都很大，当然也有提倡通过声明见名知意，但做不到那么好的话，还是要有写注释的习惯。然后就是编码规范的统一，这也很重要，不然一个公司或者一个部门，甚至一个项目出来的产品，风格都各种各样，不免有失专业（风格不是重点）。

注释的模板，可以参考【002-Idea用法-设置文件默认注释】或者【001-Idea用法-在pom.xml文件中增加模板注释】设置一些固定的注释模板。

生成设置

当代码编写完成，即需要打开打包设置

 

 

区域设置

zh_CN

其它命令行参数

-encoding utf-8 -charset utf-8 -windowtitle Tzl-Java基础库

编码需要设置，-windowtitile 是生成文档的Title

 

生成文档

上述设置完后，点击【确定】后即生成了相应的文档

 

有时候有错误的时候，也不影响生成的文档。比如：

 

其实看着报错，确实心里是不爽的。

解题尝试

》首先注释标题添加@后，将会被识别为类似注解一样的标记。如果没有声明，则会报错。那么如果把它去掉，就会不报错了。

》其实可以多看看Java默认的类注释以及官方的文档是如何对应的，比如：

 

 

》html嵌入

通过上节描述，可以看出<p>是明显的html嵌入标记，那么就可以~随意~了

》注意事项

注释一定要是/** 的格式才会被编到文档中，如果是/* 格式的，将不会被编进去，注意，避免到最后还得统一替换。

 

 

 

 题末

 @标记，还是个疑问，等有时间再研究一下这桩悬案