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