智玩网 智能科技

java中的代码注释的三个基本原则

Java代码注释规范

1、注释形式统一

在整个应用程序中,使用具有一致的标点和结构的样式来构造注释。如果在其它项目中发现它们的注释规范与这份文档不同,按照这份规范写代码,不要试图在既成的规范系统中引入新的规范。

2、注释内容准确简洁

内容要简单、明了、含义准确,防止注释的多义性,错误的注释不但无益反而有害。

版权说明:文章均为账号作者发布,不代表本网站观点与立场,如有侵权请联系我们删除

热门