java注释为什么？为什么要为程序添加注释,在java程序中如何为程序添加注释

大家好，java注释为什么相信很多的网友都不是很明白，包括为什么要为程序添加注释,在java程序中如何为程序添加注释也是一样，不过没有关系，接下来就来为大家分享关于java注释为什么和为什么要为程序添加注释,在java程序中如何为程序添加注释的一些知识点，大家可以关注收藏，免得下次来找不到哦，下面我们开始吧！

java工作中良好的代码注释习惯是什么

注释是为了方便自己或代码维护方更容易地读懂代码的用处。

一、背景

1、当我们第一次接触某段代码，但又被要求在极短的时间内有效地分析这段代码，我们需要什么样的注释信息？

2、怎么样避免我们的注释冗长而且凌乱不堪呢？

3、在多人协同开发、维护的今天，我们需要怎么样的注释来保证高质、高交的进行开发和维护工作呢？

二、意义

程序中的注释是程序设计者与程序阅读者之间通信的重要手段。应用注释规范对于软件本身和软件开发人员而言尤为重要。并且在流行的敏捷开发思想中已经提出了将注释转为代码的概念。好的注释规范可以尽可能的减少一个软件的维护成本,并且几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护。好的注释规范可以改善软件的可读性，可以让开发人员尽快而彻底地理解新的代码。好的注释规范可以最大限度的提高团队开发的合作效率。长期的规范性编码还可以让开发人员养成良好的编码习惯，甚至锻炼出更加严谨的思维能力。

三、注释的原则

1、注释形式统一

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

2、注释的简洁

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

3、注释的一致性

在写代码之前或者边写代码边写注释，因为以后很可能没有时间来这样做。另外，如果有机会复查已编写的代码，在今天看来很明显的东西六周以后或许就不明显了。通常描述性注释先于代码创建，解释性注释在开发过程中创建，提示性注释在代码完成之后创建。修改代码的同时修改相应的注释，以保证代码与注释的同步。

4、注释的位置

保证注释与其描述的代码相邻，即注释的就近原则。对代码的注释应放在其上方相邻或右方的位置，不可放在下方。避免在代码行的末尾添加注释；行尾注释使代码更难阅读。不过在批注变量声明时，行尾注释是合适的；在这种情况下，将所有行尾注释要对齐。

5、注释的数量

注释必不可少，但也不应过多，在实际的代码规范中，要求注释占程序代码的比例达到20%左右。注释是对代码的“提示”，而不是文档，程序中的注释不可喧宾夺主，注释太多了会让人眼花缭乱，注释的花样要少。不要被动的为写注释而写注释。

6、删除无用注释

在代码交付或部署发布之前，必须删掉临时的或无关的注释，以避免在日后的维护工作中产生混乱。

7、复杂的注释

如果需要用注释来解释复杂的代码，请检查此代码以确定是否应该重写它。尽一切可能不注释难以理解的代码，而应该重写它。尽管一般不应该为了使代码更简单便于使用而牺牲性能，但必须保持性能和可维护性之间的平衡。

8、多余的注释

描述程序功能和程序各组成部分相互关系的高级注释是最有用的，而逐行解释程序如何工作的低级注释则不利于读、写和修改，是不必要的，也是难以维护的。避免每行代码都使用注释。如果代码本来就是清楚、一目了然的则不加注释，避免多余的或不适当的注释出现。

9、必加的注释

典型算法必须有注释。在代码不明晰或不可移植处必须有注释。在代码修改处加上修改标识的注释。在循环和逻辑分支组成的代码中添加注释。为了防止问题反复出现，对错误修复和解决方法的代码使用注释，尤其是在团队环境中。

10、注释在编译代码时会被忽略，不编译到最后的可执行文件中，所以注释不

会增加可执行文件的大小。

四、JAVA注释技巧

1、空行和空白字符也是一种特殊注释。利用缩进和空行，使代码与注释容易区

别，并协调美观。

2、当代码比较长，特别是有多重嵌套时，为了使层次清晰，应当在一些段落的

结束处加注释（在闭合的右花括号后注释该闭合所对应的起点），注释不能

写得很长，只要能表示是哪个控制语句控制范围的结束即可，这样便于阅读。

3、将注释与注释分隔符用一个空格分开，在没有颜色提示的情况下查看注释时，

这样做会使注释很明显且容易被找到。

4、不允许给块注释的周围加上外框。这样看起来可能很漂亮，但是难于维护。

5、每行注释（连同代码）不要超过120个字(1024×768)，最好不要超过80

字(800×600)。

6、Java编辑器（IDE）注释快捷方式。Ctrl+/注释当前行,再按则取消注释。

7、对于多行代码的注释，尽量不采用“/*......*/”，而采用多行“//”注释，

这样虽然麻烦，但是在做屏蔽调试时不用查找配对的“/*......*/”。

8、注释作为代码切换开关，用于临时测试屏蔽某些代码。

为什么要为程序添加注释,在java程序中如何为程序添加注释

注释是用来给开发者或者是软件后续的维护者来看的。一般是用来描述这一段代码或者是程序做了些什么样的事情。实现了哪些功能，java里面注释代码，可以分为行注释和块注释，方法注释等。

行注释就是在需要注释的代码前加//

块注释则是用/*和*/把文本段落框起来即可

java 文档注释是注释什么的,不是有多行注释了吗

1、【文档注释】是写在类或者方法的上面的。

文档注释可以用eclipse导出chm格式的帮助文档，拿给其他人用时，方便他人理解。文档注释被调用的方法，当鼠标移到上面时提醒注释内容。

使用文档注释时，需要在开始的/**之后，第一行或几行是关于类、变量和方法的主要描述。

之后，可以包含一个或多个何种各样的@标签。每一个@标签必须在一个新行的开始或者在一行的开始紧跟星号(*)。多个相同类型的标签应该放成一组。

2、【多行注释】注释的也是方法或类，言下之意就是一次性的将程序中的多行代码注释掉，但多行注释的内容不能用于生成一个开发者文档。

3、【多行注释与文档注释的区别】多行注释的内容不能用于生成一个开发者文档，而文档注释的内容可以生产一个开发者文档。

扩展资料

java常用的文档注释标签

1、@author：标识一个类的作者

实例：@author description

2、@deprecated：指名一个过期的类或成员

实例：@deprecated description

3、@exception：标志一个类抛出的异常

实例：@exception exception-name explanation

4、{@inheritDoc}：从直接父类继承的注释

实例：Inherits a comment from the immediate surperclass.

5、{@link}：插入一个到另一个主题的链接

实例：{@link name text}

6、{@linkplain}：插入一个到另一个主题的链接，但是该链接显示纯文本字体

实例：Inserts an in-line link to another topic.

7、@param：说明一个方法的参数

实例：@param parameter-name explanation

8、@return：说明返回值类型

实例：@return explanation

9、@see：指定一个到另一个主题的链接

实例：@see anchor

10、@serial：说明一个序列化属性

实例：@serial description

参考资料：百度百科-java注释

java注释多行/**/快捷键是什么

Ctrl+Shift+/。

Java快捷键：

1.【ALT+/】

此快捷键为用户编辑的好帮手，能为用户提供内容的辅助，不要为记不全方法和属性名称犯愁，当记不全类、方法和属性的名字时，多体验一下【ALT+/】快捷键带来的好处吧。

2.【Ctrl+O】

显示类中方法和属性的大纲，能快速定位类的方法和属性，在查找Bug时非常有用。

3.【Ctrl+/】

快速添加注释，能为光标所在行或所选定行快速添加注释或取消注释，在调试的时候可能总会需要注释一些东西或取消注释，现在好了，不需要每行进行重复的注释。

4.【Ctrl+D】

删除当前行，这也是笔者的最爱之一，不用为删除一行而按那么多次的删除键。

5.【Ctrl+M】

窗口最大化和还原，用户在窗口中进行操作时，总会觉得当前窗口小（尤其在编写代码时），现在好了，试试【Ctrl+M】快捷键。

6.【Ctrl+Shift+F】

格式化代码，书写格式规范的代码是每一个程序员的必修之课，当看见某段代码极不顺眼时，选定后按【Ctrl+Shift+F】快捷键可以格式化这段代码，如果不选定代码则默认格式化当前文件（Java文件）。

7.【ALT+Shift+W】

查找当前文件所在项目中的路径，可以快速定位浏览器视图的位置，如果想查找某个文件所在的包时，此快捷键非常有用（特别在比较大的项目中）。

8.【Ctrl+L】

定位到当前编辑器的某一行，对非Java文件也有效。

9.【Alt+←】、【Alt+→】

后退历史记录和前进历史记录，在跟踪代码时非常有用，用户可能查找了几个有关联的地方，但可能记不清楚了，可以通过这两个快捷键定位查找的顺序。

10.【F3】

快速定位光标位置的某个类、方法和属性。

11.【F4】

显示类的继承关系，并打开类继承视图。

关于java注释为什么，为什么要为程序添加注释,在java程序中如何为程序添加注释的介绍到此结束，希望对大家有所帮助。