关于java代码中的注释问题。(类中方法的注释,我们一般都要写上这个方法的文档(doc),方法的参数也要有它的文档)

比如

 

 

 

/**

 *  显示人员信息列表

 *  @param userId 用户ID

 *  @return  return  返回用户列表

 */

 

 

 

这里面的汉子信息,也就是文档(doc)都不应该缺少,否则,有的checkStyle会提示你说,这里必须有文档信息。

 

 

 

注意 ,在@param后面要使用半角空格 ,否则checkStyle会说没有javadoc。

你可能感兴趣的:(java,文档,javadoc)