像写数学笔记一样去写注释文档 Thu, Oct 30, W43, 2025 Categories: Thoughts Tags: 算法开发 写代码及其注释文档和写数学笔记是一样的,都需要用严谨的语言将定义、概念阐释清楚。对于变量、类、函数等各种名称的创建要推敲,既要做到简明、准确,又要符合英语语法。例如,名词的单复数要正确,如果是由多个词组合而成的名称则要保证主谓的一致性。这一点对于开发数学软件尤为重要。有了清晰、恰当的表述,逻辑思路就会顺畅,不易在复杂的代码中迷失,也能够在最大程度上避免出错。可以说,在代码中贯彻严谨的英语语法、像写数学笔记一样去写注释文档是防御式编程方法的体现。