让程序员早点下班的《技术短文指南》

丰色 发自 凹非寺

量子位 | 社会大众号 QbitAI

对于Python来说，每天不是在写到bug，就是在择bug～

在不停coding之外，作好一些细节毋庸置疑也可以帮助我们早点平日。

这不，国内一位前端开发就总结了一篇《Python技术写到作指南》，关于如何正确写到code编者、写到PR描述等等。

这些进去虽然都是小事儿，但如果大家都不规范，code维护起来有多折磨？

懂得都懂。

那么，具体都要注意些什么呢？

Python技术写到作Tips1、code编者

code编者既是写到给自己看，也是写到给别人看的。尤其是后者，更要写到得清楚明了。

不以为然，指南给了早先注意：

（1）写到最重要信息，不写到废话

一个简便的值得注意。

错误写到法：

red = 1.2 // Multiply red by 1.2 and re-assign it（将red函数2，再赋值给它）

正确写到法：

red *= 1.2 // Apply a ‘reddish’ effect to the image（给图像应用“reddish”敏感度）

很好理解。不该复述code，要写到这段code的深层涵义，提供增量信息。

（2）code改动后编者也要更新

有这样一行code和编者：

cities = sortWords(cities) // sort cities from A to Z（由A-Z加权大城市函数）

但作者写到错了，其实sortWords函数值得注意Z-A透过加权。

不过没关系，再加个反转就好了，于是code换成这样：

cities = sortWords(cities) // sort cities from A to Z（由A-Z加权大城市函数）海南白癜风医院哪家正规
重庆看白癜风到哪家医院
上海癫痫专科医院
北京肛肠医院哪好
广州看男科哪家好