Perl 风格:代码注释的艺术

  • 解释代码的功能,而不仅仅是把 Perl 转换成英语。
  • 避免使用花哨的区块横幅。
  • 使用 /x 在正则表达式中添加注释。
  • 注释整个区块,而不是单行。
  • "关于数据的注释通常比关于算法的注释更有帮助。" (Rob Pike)
  • "基本上,避免使用注释。如果你的代码需要注释才能理解,那么最好是重写它,使其更容易理解。" (Rob Pike)

前往 命名规则 (形式)
返回 防御式编程
返回 索引

版权所有 © 1998,Tom Christiansen,保留所有权利。

标签

反馈

这篇文章有什么问题?请在 GitHub 上打开一个问题或拉取请求,帮助我们。