主要观点:代码注释与代码本身一样重要,注释对代码可读性和可维护性至关重要,自解释代码虽好但也有极限,应适时添加注释。
关键信息:作者曾因注释只说明“做什么”遭教授批评,应说明“为什么”;自解释代码要适度,避免过度描述;应根据代码情况决定是否添加注释,如代码不直观、为提高可读性等需添加,代码本身能体现行为和上下文则可不加;虽讨厌文件等开头的标准注释块,但理解其提供的 IntelliSense 文档价值。
重要细节:作者大学时参与项目需注释代码,起初只写“做什么”,遭教授批评后明白要写“为什么”;举例说明过度描述方法名虽好但不如添加注释清晰;强调代码审查时要同时审查代码和注释;提到何时考虑添加和不添加注释的情况;最后提及虽讨厌标准注释块但理解其价值。
**粗体** _斜体_ [链接](http://example.com) `代码` - 列表 > 引用
。你还可以使用@
来通知其他用户。