虽然最好的代码可能是自文档化的,但即使是最清晰的代码也需要充分的文档,以便人类读者能够快速解析和理解。
但在实践中,在哪里以及写多少注释更多地取决于个人开发人员的决定,而不是代码本身的要素。编译器或解释器通常不关心你的注释;毕竟,它们不是为它们准备的,而是为我们人类准备的。因此,虽然一些组织和项目会提供指南,但注释风格更开放于解释。
一般来说,清晰简洁的注释会受到欢迎。但尤其是在开源中,你不能想当然地认为其他查看你代码的开发人员熟悉编写代码的上下文。每个人在某个时候都是项目的新手,你不能指望他们理解项目的历史、怪癖或它使用的库。新的贡献者也可能不是你的母语使用者。
因此,写得好且位置恰当的注释是你项目文档的重要组成部分。你是否确保你的项目代码尽可能易于访问?
你多久注释一次?你认为你注释得足够频繁吗?请告诉我们你的想法!
9 条评论