Java的文档注释(帮助文档)错误教训

1、有主函数main的class类应该与需要注释的方法的class分开写,要不然在cmd时会出现无此class也就是我们需要注释的文件找不到。

Java的文档注释(帮助文档)错误教训

解决:当需要注释的不是含有主函数的类时需要类名分开保存,这样就可以避免找不到的文档化的类了。 

Java的文档注释(帮助文档)错误教训 

2、需要加public,因为是分开写的所以我们需要注释的类的无法运行:

Java的文档注释(帮助文档)错误教训

 但是在main的class中可以运行,前提是:Java的文档注释(帮助文档)错误教训

3、注释要规范:(这是我注释不规范报的错误)

Java的文档注释(帮助文档)错误教训 

 @param后面加参数名要单独出来列如:@param x 这个参数代表 

 4、命令规范:(举例)

javadoc -d . -version -author MyTool.java