一、编写代码时:
(一)首先做到细心,避免出现的语法错误(少标点符号或者没用英文状态下的标点等);
(二)牢记简约而清晰的理念。
(1)编写一个文档,正确的路径是:
不要一开始就企图编写完美无缺的代码。自定义工作流程时,先尽可能在一个文件中完成所有的工作。确定一切都能正常运行后,再决定是对其做进一步改进。先让代码可行,再让代码有序。
改进时:
a.可将完成大部分工作的代码都移到函数或者类,并储存在独立模块中(注意储存在同一模块中的类和函数数量不受限制,但应存在某种相关性),这会让主程序更清晰。将函数或类储存在独立的文件(模块)中,导入该模块,你依然可以使用其所有功能,只要他们能像你希望的那样工作,你就可以不管这些文件,而专注于主程序的高级逻辑了。如果喜欢模块和文件的交互方式,可在项目开始时就尝试将类存储到模块中。
b.当然主程序的结构也要考虑是否合理,具体的代码内容是够还需要改进.
这里针对的是程序的整体结构(整体的工作路径是否合理及是否还能优化)
以及具体内容,比如while,if结构,for结构的应用,有时候还要考虑到元组,列表,字典甚至单个变量的应用。
(对这一部分应该还需要再学习数据结构和算法才能有进一步了解。)
为了与其他程序员合作,你还应该编写并及时更新注释(针对函数、文档内部的某一代码块,用#)及文档字符串(用三个引号,针对于描述某个模块,函数及整个文档的作用P154)。
(2)编写其中的某一部分模块,路径应是:
同样不要一开始就企图编写完美无缺的代码;不要一开始就设置过分复杂的代码结构或者考虑太多的特殊情况。先考虑大部分的普遍现象,对其编写行之有效的代码,再决定是对其做进一步改进,还是转而去编写新代码。
改进(重构)时要考虑下面abc三点:
首先说一下重构的含义(P183下):
重构是指:代码能够正确的运行,但可做进一步的改进——将代码划分为一系列完成具体工作的函数的过程。重构让代码更清晰、更易于理解、更容易扩展。
a.是否已将情况都考虑全面,如何合理地将遗漏情况加进去;
(P183下的例题中:重构时依次将没有考虑进去的问题考虑上:新注册用户和已经注册的老用户。其实我觉得这两点在一开始编写时就该考虑进去,这个还是比较简单容易想到的。但是如果提前就考虑多种情况,写代码时的难度会加大,思路要十分清楚。如果实在混乱写不下去,不要忘记还可以回到这里,先考虑最通常的情况,再将特殊情况一个一个的加进去。)
b