• 技术文章 >java >java基础

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

    小妮浅浅小妮浅浅2021-04-21 10:16:45原创1345

    1.添加注释的位置

    (1)类,接口

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

    (2)方法

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

    (3)常量

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

    (4)关键算法上

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

    2.添加注释的原则

    (1)注释形式统一

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

    (2)注释内容准确简洁

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

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

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

    专题推荐:java注释
    品易云
    上一篇:Java基础之如何快捷键生成文档注释? 下一篇:Java基础里的@Target是什么?怎么用?

    相关文章推荐

    • java基础中JRE、JDK、JVM是什么?• java基础:编译运行过程如何实现?• Java基础之有哪些注释方法?怎么用• Java基础:如何使用IDEA?• Java基础之如何快捷键生成文档注释?• json字符串转换为java对象原理

    全部评论我要评论

    © 2021 Python学习网 苏ICP备2021003149号-1

  • 取消发布评论
  • 

    Python学习网