文件名称:基本风格指南-qt教学大纲
文件大小:5.26MB
文件格式:PDF
更新时间:2024-06-23 19:46:12
python 核心编程 中文版 高清文字版
3.4 基本风格指南 注释 注释对于自己和后来人来说都是非常重要的,特别是对那些很久没有被动过的代码而言, 注释更显得有用了。既不能缺少注释,也不能过度使用注释。尽可能使注释简洁明了,并放在 合适的地方。这样注释便为每个人节省了时间和精力。记住,要确保注释的准确性。 文档 Python 还提供了一个机制,可以通过__doc__特别变量,动态获得文档字串。在模块,类 声明,或函数声明中第一个没有赋值的字符串可以用属性 obj.__doc__来进行访问,其中 obj 是一个模块,类,或函数的名字。这在运行时刻也可以运行。 缩进 因为缩进对齐有非常重要的作用,您得考虑用什么样的缩进风格才让代码容易阅读。在选 择要空的格数的时候,常识也起着非常大的作用。 1 或 2 可能不够,很难确定代码语句属于哪个块 8 至 10 可能太多,如果代码内嵌的层次太多,就会使得代码很难阅读。四个空格非常的 流行,更不用说 Python 的创造者也支持这种风格。五和六个也不坏,但是文本编辑器通常不支 持这样的设置,所以也不经常使用。三个和七个是边界情况。