注释要怎么用---Day09

作为一个刚入行的菜鸟，感觉最痛苦的就是看前辈们写的代码，需求文档看的很明白，可是拿过代码来就不一样了，很多时候真是恨不得自己重新进行编写，可是看那浩大的工作量却很无奈啊，前辈啊，大神啊，你写个注释能怎么滴，这密密麻麻几页全是代码，连个汉字都看不到，好痛苦的...

我决意要坚持写注释，希望别人能懂，也希望回头看自己的代码，也能很快想起怎么当时的思路。

下面说说我的注释观念：

1、何为注释

“注释”在我的理解中有这么几层意思：注：注意、注解；释：解释，释义；也就是说“注释”，就是来让人明白，让人注意的，至少知道你写这段代码的目的是什么。

所以，注释上不是说如何去做的，而是为什么有了它。

2、注释的原则

所谓“原则”，网络上有特别多，我这里就只说特别在意的几点：

a、这不是文档，不需要1:1，只要可以保证能够理解思路即可；

b、正确性很关键；如果注释错了，会让人理解起来更加麻烦，思路都会被打乱，严重影响进度；

c、就近、简洁、美观、必备；感觉需要注释，也就是自己感觉在编写中应该注意的地方，在最近的地方，简单美观的表达，这是最合理的表现

3、注释的方法

在不同的位置，可能因为不同的需求，注释的方法也不尽相同，我们来一一介绍：

a、在源文件中

在源文件中，存在的基本注释方法有三种：一、单行注释“//”；二、多行注释“/***/”和“/**/”

有少量模块中需要注意时，可以使用//单行注释，但是对于方法、文档、接口或者类注释时，建议使用多行注释，尤其是在myeclipse和eclipse中，多行注释会变成蓝色，只要缩进弄规范了，会更美观，另外多行注释中可以应用单行注释

b、jsp中的注释

jsp中的注释方法，存在如下几种：显示注释<!--sos-->；隐式注释<%--sos--%>,以及java中的注释方法//sos和/*sos*/,而且这两种也是隐式的。

所谓显示注释，也就是说虽然在页面上不显示，但是在查看源文件的时候可以看到；而隐式的则无法看到

另外<!--sos-->同样可以用于html，在jsp中使用时，可以认为是不够彻底的注释，在特定情况下可能还会影响到程序，所以我们更多是建议使用<%--sos--%>

c、html注释

正如上面所说的<!--sos-->,就不再多说了

d、css中的注释

css中加入注释很多时候是很有必要的，因为国人还是对汉语更敏感，在寻找的时候更快捷一点吧感觉，但是实用性仿佛不是很强感觉，也可能是我应用还较少的缘故，随时感觉观察吧。

/*sos*/来注释，当然在css单独的文件中同样是用这种方法

e、js中的注释

js在当前页面和引入文件中的注释方法是不同的

在当前页中的注释方法雷同于java文件：像//和/**/

而在引入文件中，则是<!--

这具体原因javascript能识别html注释的开始部分，并将其看作为单行注释并结束，但一旦加上-->则会被javascript所忽略，不能被显示

说了这么多，也总算有点眉目，好好用注释吧，不是都追求开源么，让别人更懂你一点，配合才会更默契吧，加油...