Welcome, Old Sport!

你真的会写代码注释?

by ilikecss ON 2016/03/29 1227

are-you-really-good-html-and-css-comments-cover在你学习html&css基础的时候肯定会接触到写代码注释。然而,至今还有许多开发者们不会掌握代码注释的优点。我们在html&css中广泛地使用代码注释,但要融汇贯通语义才真正对我们工作有所帮助。

比如你在一家新公司工作,每个公司都有自己不同的代码库,模块框架等等。业界里有一句老话:”好的代码是不需要注释的”。 扪心自问你是否觉得没有注释的查看代码真的很累?

代码注释的两个真相:

  1. 代码注释是被浏览器无视的
  2. 压缩代码会无视注释

综合上述我们可以理解,代码注释是给人来阅读的。。。

为什么代码注释很重要?

如果你是个自由职业者检查你的代码时,你很容易给你的代码添加合理的注释或者根本不添加注释。很多时候开发者们回头在看自己的代码时会惊叹: 这写的什么鬼?给代码注释有几个优点如下:

  1. 代码注释可以保持统一性
  2. 代码注释便于理解
  3. 代码注释便于您快速修改错误
  4. 代码注释能够提高协作能力

注意事项:

只在必要时写: 注释因该写在一些不太容易区分的地方,如果你的代码够吊,因该很容易让人理解和阅读。

别写的太啰嗦,这样只会暴露你的low!

呵呵,别花太多时间在写代码注释上面。

注释不仅仅用于代码中,在版本控制中几乎都会使用到。

技术宅的冬天

3条评论
  1. 咋突然变成神配图风格了?

  2. #2

    zengda说道:

    不错,不错,看看了!




TOP