这篇文章给大家分享的是有关java中类文件注释规约的示例分析的内容。小编觉得挺实用的，因此分享给大家做个参考，一起跟随小编过来看看吧。
为了区分作者和版本的概念以及，开发请遵守下面设置。 如：现在项目大版本为1，创建类文件模板默认因为版本1。 作者名字为自己的名字，如需要在类里新增特性方法，需要在类作者上加入自己的名字。 修改小的bug不需要加入自己的名字。
设置里：Preferences | Editor | File and Code Templates cdn.nlark.com/yuque/0/2019/png/204430/1557802550824-25113b0e-236d-4934-b08d-61c84581f25d.png"> 点击导航栏Includes->列表文件File Header 添加内容保存即可。
/** * @author <作者> * @since <版本> */
如下，创建类默认加入类注释头部。（请务必需要在注释上标注该类的使用用途）
/**
* {@link RestController} Test测试Controller
*
* @author purgeyao
* @since 1.0
*/
@RestController
public class TestController {
@GetMapping("test")
public String test(){
return "123";
}
}如果你不是该类的创建者，要增加新的特性方法，需要在注释头部加入自己的author。 修改小的bug则不需要添加自己的author
/** * @author purgeyao * @author <自己的名字> * @since 1.0 */
版本请和当前项目版本大版本一致。（如：该项目为2.0版本，请在idea模板里将@since改为2.0） 项目大版本升级请更新@since版本，为了好区分类的作用以及处于项目那个版本创建。
/** * @author purgeyao * @since 2.0 */
感谢各位的阅读！关于“java中类文件注释规约的示例分析”这篇文章就分享到这里了，希望以上内容可以对大家有一定的帮助，让大家可以学到更多知识，如果觉得文章不错，可以把它分享出去让更多的人看到吧！
免责声明：本站发布的内容（图片、视频和文字）以原创、转载和分享为主，文章观点不代表本网站立场，如果涉及侵权请联系站长邮箱：is@yisu.com进行举报，并提供相关证据，一经查实，将立刻删除涉嫌侵权内容。
