这篇笔记参考 Google开源项目风格指南 编写,与其中的部分内容略有出入。
0 前言
保持代码编写风格的统一有助于保持……代码编写风格的统一。好吧,总之就是想对自己所写的项目代码做一个可能有帮助的规范——没想到我还没学会什么语言就被迫开始写项目,都是因为可恶的毕业设计——来帮助我修改bug,和增添一些可能会有的工作量,好显得我写的东西大概很多且正规。
整齐的东西总能让人感到开心和舒适,尤其是有整齐的东西被我弄乱的时候,特别是被我弄乱的整齐的东西可以重新自己变得整齐的时候。
我也许应该考虑写一个什么脚本,可以一键规范整个代码风格。
总之,写这篇笔记的主要目的是参考 Google 的开源项目风格来规范一下风格,和……充实一下这个网站的文章。
本篇是关于 Python 的风格规范。
1 关于行
1.1 80 字符行长
每行不超过 80 个字符。或许做不到严格 80 个字符,总之不要太长。
Python 会自动将 ()
[]
{}
中的行链接起来,因此,可以利用如下的方式进行分行。
注释不在换行特点内,尽量不给注释换行
x = ('一行很长的文字'
'另一行很长的文字')
# 特别长的注释写在同一行就好了,比如说这个网站的网址 https://lyrikp.art/
1.2 结构之间空行
顶级定义之间空 2 行,方法之间的定义空 1 行
在顶级的定义,如 函数定义 和 类定义,之间空两行。
类中的方法、类与第一个方法之间。空一行。
在函数或者方法中,合适的结构地方,空一行。
评论