栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Java

Java基础中注释添加的位置以及原则详解

Java 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

Java基础中注释添加的位置以及原则详解

在之前的文章中学习了不少关于java注释的方式以及快捷操作,有些人还不清楚应该注释的位置,以及注释时需要注意的原则。注释位置为类,接口、方法、常量、关键算法,原则有注释形式统一和注释内容准确简洁。接下来我们就具体的情况展开讲解。

1.添加注释的位置

(1)类,接口

这一部分注释是必须的。在这里,我们需要使用javadoc注释,需要标明,创建者,创建时间,版本,以及该类的作用。

(2)方法

在方法中,我们需要对入参,出参,以及返回值,均要标明。

(3)常量

对常量,我们需要使用多行注释,进行标明该常量的用途,如下所示:

(4)关键算法上

在关键算法上,添加注释并且按照顺序依次标明,写明白该方法为什么这么做。

2.添加注释的原则

(1)注释形式统一

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

(2)注释内容准确简洁

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

以上就是我们在Java基础中注释添加位置以及原则的详解,学会了的小伙伴在使用java注释时一定要时时牢记,本篇内容到这里就结束啦。

转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/15376.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号