对编程注释的理解

  注释写得很出色很不容易，但是写得糟糕却是人人可为止，糟糕的注释反而会帮倒忙，给阅读代码的程序员指向了一个错误的方向。很多技术文档中，已经有很全面的说明，这里不再多说，下面仅说明下自己的一些见解。

怎样才能写出出色的注释

1、同一个工程中，注释的格式要统一，因为代码阅读器对不同位置的注释语句，显示格式是不同的，如果格式不统一，代码的外观就会给人的感觉很杂乱，导致可读性变差。

2、代码中的一些重要信息要规定为必须注释，比如：函数头

函数名：
参数：
    @in:
    @in:
    @out:
返回值：
函数更新日志：
    创建人：    创建日期：
    更改人：    更改日期：

  如果对代码中的变量进行了缩写，就一定要注释变量的意义。

3、注释的内容：重点注释程序中的编程思路，而不是注释这段代码做了什么

  因为程序猿们对自己近期刚编写的代码暂时是很熟悉的，甚至有时候会自信到，对于这块刚编写的代码已经熟悉到自己可以记住一辈子，但是 但是 但是 工作中总是充满了但是，过了一个月或两个月我们就会把当时的思路几乎忘得一干二净。

4、一些大公司里的代码是没有注释的，只是注释函数头，至于代码里是怎么做的，不做具体的注释，只是用更规范的变量命名和函数命名来代替注释，基本上内部人员看完就能知道是哪些代码是做的哪些事情。