全国旗舰校区

不同学习城市 同样授课品质

北京

深圳

上海

广州

郑州

大连

武汉

成都

西安

杭州

青岛

重庆

长沙

哈尔滨

南京

太原

沈阳

合肥

贵阳

济南

下一个校区
就在你家门口
+
当前位置:首页  >  技术干货

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

发布时间:2022-08-10 10:45:00
发布人:wjy

  1.添加注释的位置

  (1)类,接口

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

  (2)方法

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

  (3)常量

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

  (4)关键算法上

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

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

  2.添加注释的原则

  (1)注释形式统一

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

  (2)注释内容准确简洁

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

  在之前的文章中学习了不少关于java注释的方式以及快捷操作,有些人还不清楚应该注释的位置,以及注释时需要注意的原则。注释位置为类,接口、方法、常量、关键算法,原则有注释形式统一和注释内容准确简洁。以上就是我们在Java基础中注释添加位置以及原则的详解,学会了的小伙伴在使用java注释时一定要时时牢记,本篇内容到这里就结束啦。

  推荐操作环境:windows7系统、java10版,DELL G3电脑。

  更多关于“Java培训”的问题,欢迎咨询千锋教育在线名师。千锋已有十余年的培训经验,课程大纲更科学更专业,有针对零基础的就业班,有针对想提升技术的好程序员班,高品质课程助力你实现java程序员梦想。

相关文章

Tornado的核心是什么?

Tornado的核心是什么?

2023-10-14
ORM解决的主要问题是什么?

ORM解决的主要问题是什么?

2023-10-14
敏捷开发中为什么很少用到Youtrack工具?

敏捷开发中为什么很少用到Youtrack工具?

2023-10-14
持续集成和版本控制如何区别?

持续集成和版本控制如何区别?

2023-10-14

最新文章

常见网络安全面试题:Windows常用的命令有哪些?

常见网络安全面试题:Windows常用的命令有哪些?

2023-10-09
常见网络安全面试题:根据设备告警如何展开排查?

常见网络安全面试题:根据设备告警如何展开排查?

2023-10-09
常见网络安全面试题:mysql加固呢?(数据库加固)

常见网络安全面试题:mysql加固呢?(数据库加固)

2023-10-09
常见网络安全面试题:windows和linux加固?(操作系统加固)

常见网络安全面试题:windows和linux加固?(操作系统加固)

2023-10-09
在线咨询 免费试学 教程领取