主要观点:
- 代码用结构化机器语言编写,注释用富有表现力的人类语言编写,“注释原因而非内容”应将信息尽可能推入标识符,但并非所有内容都能如此嵌入。
- 近年来有人认为“原因”不应在注释中,可嵌入到长函数名或测试用例名中,几乎所有“自文档化”代码库都通过添加标识符来添加文档。
- 否定信息(如系统中的“为何不”)无法用更多代码表示,如在处理 epub 数学符号转换时,选择简单但慢的代码并添加注释说明原因,即使代码目前没问题,注释也很重要,能表明作者知晓权衡。
- 自文档化无法表示否定信息,如不能用一个函数名同时包含“函数功能”和“所做权衡”,用测试也无法直接测试相关内容。
关键信息:
- 2024 年 9 月 10 日,《Logic For Programmers v0.3》发布,可在[https://leanpub.com/logic/]获取,v2 和 v3 的差异可在[https://bsky.app/profile/hill...]查看。
- 举例说明在处理 epub 数学符号转换时使用慢代码并添加注释的情况及原因。
- 提及有人认为可将注释转为日志使代码更自文档化但未写成博客文章。
重要细节:
- 文中提到通过添加标识符来添加文档的普遍做法。
- 解释了自文档化无法表示否定信息的原因及相关尝试的局限性。
- 介绍了订阅方式和相关网站信息。
**粗体** _斜体_ [链接](http://example.com) `代码` - 列表 > 引用
。你还可以使用@
来通知其他用户。