主要观点:代码注释常被开发者认为是浪费时间或代码可改进的标志,但这种观点大多时候是错误的。应注释“为什么”而非“如何”。
关键信息:
- 常见观点认为应避免注释,若代码需注释则应重写使其自明。
- 新学生常按每一行代码都需注释的要求做,如示例代码。
- 注释“如何”的风格无价值,代码本身能说明如何做事。
- 偶尔会遇到难以理解的代码,如支付处理公司的复杂 SQL 查询。
- 以 React 代码为例,注释解释了代码的“为什么”,如处理
key
属性的问题。 - 作者写的 TypeScript => Closure Compiler 代码中的注释很有价值。
重要细节: - 给出了具体的代码示例,如支付处理公司的 SQL 查询和 React 代码中的相关部分。
- 解释了代码中的一些技巧,如
'' + maybeKey
将maybeKey
转换为字符串。
**粗体** _斜体_ [链接](http://example.com) `代码` - 列表 > 引用
。你还可以使用@
来通知其他用户。