Day 5

Day 5

优雅代码编写指北

01代码风格

• ”修饰“的前提一定是”跑通“代码，也就是说先保证code 没有任何bug

• ”修饰”不是每个人强制的内容

02缩进与执行

1. 如果有开始定界符，其余行的缩进需与开始定界符对齐

2. 需要额外的4个空格（长度等于一个Tab键），以区分传入参数和其他内容

3. 空格一般用于添加以上这种缩进，Tab键一般用于保持行与行之间的一致性

4. 多行if语句衔接，需要一个额外的缩进，以区分其他内容

代码布局----换行

1. 将所有行列限制为最多79个字符

2. 一般语句接受“隐式”延续，但是with语句等不支持，需要使用反斜杠 \ 来衔接

3. 另一个这样的例子是 assert语句

4. 多行 if 的缩进 ，4空格

5. 通常不建议使用复合语句（同一行上多个语句）

03导入规范

1 if foo == 'blah':

2 do_blah_thing()

3 do_one()

4 do_two()

5 do_three()

多个参数加减，把符号放前面一列会很清晰

import 本地模块/包

1. 当我们需要导入本地自己封装好的一些模板时，需要通过import来导入

2. 如果我们需要在ma.py文件中导入同目录下的m2.py文件，直接导入即可

例如：

1 Tree

2 m1.py

3 m2.py

4 Branch

5 m3.py

6 m4.py

7 from Branch import m3

8 m3.printSelf() #输出 In m3

 

关于空格

建议式：

i = i + 1

submitted += 1

x = x*2 - 1

hypot2 = x* x + y*y(x x没有空格此处是为了写出来)

c = (a+b) * (a-b)

1坚持在圆括号，方括号或大括号内，不需要多余空格；

2在逗号，分号或冒号之前，尾随逗号之后均不需要多余空格；

3在切片中，两个冒号必须应用相同的间距；

4紧接在开始函数调用的参数列表的左括号之前，不需要多余空格；

5赋值（或其他）运算符周围需要多个空格以使其与另一个运算符对齐；

代码注释

• ·注释就是对代码的解释和说明，其目的是让人们能够更加轻松地了解代码

• 注释是编写程序时，写程序的人给一个语句，程序段，函数等的解释或提示，能提高程序代码的可读性

• 在有处理逻辑的代码中，源程序有效注释量必须在20%以上

命名规则

• 变量名只能包含字母，数字和下划线。变量名可以字母或下划线打头，但不能以数字打头，例如，可将变量命名为message_1，但是不能将其命名为1_message。

• 变量名不能包含空格，但可使用下划线来分隔其中的单词。例如，变量名greeting_message可行，但变量名greeting message会引发错误。

命名规范

• 不要将python关键字和函数名用作变量名，即不要使用python保留名用作特殊用途的单词，如print

• 变量名与函数名应既简短又具有描述性。例如，name 比 n 好， student_name 比 s_n 好