美文网首页iOS聪少Harry笔记每周500字
如何写注释(一)-----《代码整洁之道》读书笔记

如何写注释(一)-----《代码整洁之道》读书笔记

作者: 刚刚悟道 | 来源:发表于2016-02-27 22:21 被阅读399次

程序员要学会写注释。
对于注释,必须明白:注释,最多是一种不得不为的“恶”。再好的注释,也是迫不得已才写。能不写就不写。
好的注释是这样的:

  • 对意图的阐释。
  • 对程序员的警示。比如有一段非常危险的代码,一定要通过注释将这种危险传达给程序员。
  • 对某段代码作用或功能的放大。
  • 好的注释美化不了糟糕的代码。首选做法不是写“注释”,而是优化代码,通过代码传达意图。
  • 法律信息。比如版权等信息。
  • 提供信息。
    TODO注释。有时某段代码由于某种原因暂时不能写,就可以使用TODO注释标记。需及时整理TODO注释,
    时间久了,TODO注释会变为无用的坏注释。

相关文章

网友评论

    本文标题:如何写注释(一)-----《代码整洁之道》读书笔记

    本文链接:https://www.haomeiwen.com/subject/kagwkttx.html