Java 实践:注释的书写规范
2015-02-12
背景
Java 源码中,注释的书写规范,下述场景如何书写注释:
- 链接到另一个类内的方法
- 链接到外部 url
- … 等等
常见写法
几种常见写法:
@link 语法
{@link package.class#member label}
而想为文档注释添加url链接可以使用@see,比如
@see <a href="http://google.com">http://google.com</a>
参考资料
原文地址:https://ningg.top/java-comment-style/