Python文档

时间:2021-08-19 21:34:02

详细的为代码编写文档,这其实是写好代码的重要部分。

常见编写代码的陷阱:

1、别忘了冒号。一定要记住在复合语句首行末未输入“:”

2、从第一行开始。要确定顶层(无嵌套)程序代码从第一行开始。这包括在模块文件中输入的无嵌套的代码,以及在交互模式提示符下输入的无嵌套的代码

3、空白行在交互模式提示符下很重要。模块文件中符合语句内的空白行都会被忽略,但是,交互模式提示符下输入代码时,空白行则是会结束语句。

4、缩进要一致。避免在块缩进中混合制表符和空格。每个块全都使用制表符或空格,这样比较安全

5、不要在Python中使写C代码

6、使用简单的for循环,而不是while或range。比起while或者range方式的计数器循环来讲,简单的for循环,总是比较易写运行起来也更快。因为Python

会在内部为简单的for循环处理索引运算,因此有时会比等效的while快两倍。

7、要注意赋值语句的可变对象

8、不要期待在远处修改对象的函数会返回结果。比如list.append方法的修改运算,不会有返回值(除了None),所以在调用时不要对其结果进行赋值

9、一定要使用括号调用函数。必须在函数名称后面加括号才能对它进行调用,无论它是否带有参数。

10、不要在导入和重载中使用拓展名或路径。