codecamp

Python 注释写作规范 | Google 官方标点语法指南

标点符号、拼写和语法

Tip
注意标点符号、拼写和语法。文笔好的注释比差的注释更容易理解。

注释应该和记叙文一样可读,使用恰当的大小写和标点。一般而言,完整的句子比残缺句更可读。较短的注释(比如行尾注释)可以更随意,但是你要保持风格一致。

尽管你可能会因为代码审稿人指出你误把冒号写作逗号而灰心,但是保持源代码清晰可读也是非常重要的。正确的标点、拼写和语法有助于实现这一目标。

Python 文档字符串规范 | Google 官方 PEP-257 实战
Python 字符串规范 | Google 官方 f-string 最佳实践
温馨提示
下载编程狮App,免费阅读超1000+编程语言教程
取消
确定
目录

关闭

MIP.setData({ 'pageTheme' : getCookie('pageTheme') || {'day':true, 'night':false}, 'pageFontSize' : getCookie('pageFontSize') || 20 }); MIP.watch('pageTheme', function(newValue){ setCookie('pageTheme', JSON.stringify(newValue)) }); MIP.watch('pageFontSize', function(newValue){ setCookie('pageFontSize', newValue) }); function setCookie(name, value){ var days = 1; var exp = new Date(); exp.setTime(exp.getTime() + days*24*60*60*1000); document.cookie = name + '=' + value + ';expires=' + exp.toUTCString(); } function getCookie(name){ var reg = new RegExp('(^| )' + name + '=([^;]*)(;|$)'); return document.cookie.match(reg) ? JSON.parse(document.cookie.match(reg)[2]) : null; }