Python 注释写作规范 | Google 官方标点语法指南
2025-07-30 11:40 更新
标点符号、拼写和语法
Tip
注意标点符号、拼写和语法。文笔好的注释比差的注释更容易理解。
注释应该和记叙文一样可读,使用恰当的大小写和标点。一般而言,完整的句子比残缺句更可读。较短的注释(比如行尾注释)可以更随意,但是你要保持风格一致。
尽管你可能会因为代码审稿人指出你误把冒号写作逗号而灰心,但是保持源代码清晰可读也是非常重要的。正确的标点、拼写和语法有助于实现这一目标。
以上内容是否对您有帮助:
更多建议: