Collection of Elegant Coding Style
2018-07-16 发布
475 字 • 2 分钟
~ 持续汇总优雅的代码、码代码姿势,减少给自己找事:
开发习惯
Code a little, run a little, fix a little.
Make sure parts of your programs work as you work on them. Do not write massive files of code before you try to run them. Code a little, run a little, fix a little.——《Learn Python The Hard Way》
即写完一部分代码就及时运行检查,确认这部分代码是否实现了目标,而非等所有都写完了才运行。
那如何确保实现了目标?测试。例如:需要批量处理多个 csv 文档中的数据,可先输入一个经典的目标文档测试看下效果,再换几个文档测试,最后批量输入目标文档。
Readme Driven Development
先把通用的头尾内容写完,搭出框架,再填内容
如编码格式、作者、版本、编辑日期等。
又如写 if else 时,先把整体框架写完,再逐级思考:else 都先用 pass ,暂不处理;把 if 写完后再处理 else 。
代码风格
-
Python 代码规范:PEP 8 -- Style Guide for Python Code | Python.org
-
思考和开发习惯向 编程的智慧 靠拢,写清晰易懂的代码
-
设定样式大小时,设置基础值,其它依赖函数关系自动增减即可。比如:
// Font size $font-size-base : 17px; $font-size-small : $font-size-base - 2px; $font-size-smaller : $font-size-base - 4px; $font-size-large : $font-size-base + 2px; $font-size-larger : $font-size-base + 4px; // Headings font size $font-size-headings-step : 2px; $font-size-headings-base : 27px; $font-size-headings-small : $font-size-headings-base - $font-size-headings-step; $font-size-headings-smaller : $font-size-headings-small - $font-size-headings-step; $font-size-headings-large : $font-size-headings-base + $font-size-headings-step; $font-size-headings-larger : $font-size-headings-large + $font-size-headings-step;
其它
- 如何向别人清晰解释某个特性用法,可参看这个理解
- 如何令初阶用户也能在非 CLI 界面轻松理解、自行修改配置,可参看这个 blog _config.yml 怎么写。
▶CHANGELOG
- 180716 创建
微信扫一扫赞赏作者