别忘了注释

早上在群里看见一条消息，说是美国的一名程序员跑到办公室开枪击中了四名同事，这件事引起了广泛的讨论，有人说可能是“同事不写注释，不遵循驼峰命名，括号换行，最主要还tian天天 git push -f 等因素”激怒了这么程序员，不管真实情况如何，作为程序员的我们都应该为自己的生命安全着想了（放心我们的国家还是很安全的），随即想写一篇小文章介绍一下注释，警醒一下自己，不说废话了，开写。

注释的重要性：代码即文档，注释：一般占总代码百分之三十，我们写的的代码不只是写完就万事大吉了，代码还要后期维护，扩展、优化等这都需要我们的代码具有非常高的可读性，大一点的公司不仅要写注释而且对注释也是有严格的规范的，由此可看出注释在代码中的重要性。

注释的分类及用法：注释一般分为 单行注释（注释少量代码或者说明内容）、多行注释（注释大量的代码或者说明内容）、文档注释（负责描述类、接口、方法、构造器、成员字段。可以被JDK提供的工具 javadoc 所解析，自动生成一套以网页文件形式体现的该程序说明文档的注释。）

注释的表现形式：（依次为单行、多行、文档）：java：// 、/* 内容 */、/** 内容 */。

                                                                         c# : // 、/* 内容 */、///。

IDE下注释使用：Eclipse Java Photon：Ctrl + / 注释当前行,再按则取消注释 （可选中多行-每行都是单行注释形式）

                                                                Ctrl + shift + / 注释多行   或者 /* + 回车键（自动加*/）

                                                                 /** + 回车键

                           Visual Studio ：    ctrl + k 然后ctrl + c注释选中行        ctrl + k 然后ctrl + u取消注释选中行 （可选中多行-每行都是单行注释形式）

                                                          /* + 回车键  （需要自己加*/结尾)

                                                          /// + 回车键

注意：《1》文档注释必须写在类、接口、方法、构造器、成员字段前面，写在其他位置无效。

            《2》注释也有书写规范和格式，文档注释可自己设置格式 最好按照所需规范进行设置。                 
--------------------- 
作者：LJH_Gemini 
来源：优快云 
原文：https://blog.youkuaiyun.com/LJH_Gemini/article/details/82820620 
版权声明：本文为博主原创文章，转载请附上博文链接！