前一阵子出差、渡假、出差，以致於一直在调时差，明明只剩下最後的三篇却迟迟未交稿 。趁周末把剩下的交齐，算是完成一件事。感谢各位的收看。 ------ 正文开始 ------ 原文网址：http://google-styleguide.googlecode.com/svn/trunk/pyguide.html * 命名规则 module_name, package_name, ClassName, method_name, ExceptionName, function_name, GLOBAL_CONSTANT_NAME, global_var_name, instance_var_name, function_parameter_name, local_var_name. - 避免使用的命名法 1. 除了计数器及迭代器之外，不要用单一字母为变数命名。 2. package 及 module 的名称中不要包含破折号 "-" 3. 变数名称前後不要加上两个双底线 (如：__double_leading_and_trailing_underscore__ )。 - 命名惯例 1. "internal" 指 module 内或 class 中的 private 或 protected 的变数。 2. 要保护 module 变数或函式，可在变数名称前加上单一底线，若用 from foo import * 时，这些变数不会被 import。(编案：若用 from foo import _var 则还是能使用 _var 变数)。若要在 class 内宣告 private 变数或方法，则在变数名或 方法名之前加上两个底线 (__)，private 的效果是透过 name mangling 达成。(编案： name mangling 本质上只是把变数重新命名，因此使用者若执意要呼叫 private 变数还 是能够达成。) 3. 把相关的 class 及 顶层的 function 放在同一个 module 中。你不需要像 Java 般 限制每个 module 只能有一个 class。 4. 命名 class 时，使用每个单字的字首用单写 (如：CapWords)。命名 module 时，用 小写及底线 (如：lower_with_under.py)。虽然某些既有的 module 命名仍使用大写字 母 (如：CapWords.py)，但不建议这麽做，因为当 module 名称与 class 名称相同时它 们将难以分辨。(你通常写 import StringIO 或 from StringIO import StringIO ?) - 命名通则 package: lower_with_under (public) modules: lower_with_under (public), _lower_with_under (internal) classes: CapWords (public) _CapWords (internal) exceptions: CapWords (public) functions: lower_with_under() (public), _lower_with_under() (internal) global/class constants: CAPS_WITH_UNDER (public), _CAPS_WITH_UNDER (private) global/class variables: lower_with_under (public), _lower_with_under (private) instance variables: lower_with_under (public), _lower_with_under (protected), __lower_with_under (private) method names: lower_with_under() (public), _lower_with_under() (protected), __lower_with_under() (private) function/method parameters: lower_with_under local variables: lower_with_under (public) * Main 即使是一个 script，也应该要能被 import，import 别人後的 script 也不该有副作用。 主函式要放在 main() 函式中。在 Python 中, pychecker, pytdoc, 及 unit test 的 module 都应该能被 import。为确保 module 被 import 时不会执行主程式，每一个 module 在执行主程式前都应先检查 if __name__ == '__main__'。 def main(): ... if __name__ == '__main__': main() 当一个 module 被 import 时，顶层的所有程式码都会被执行。因此，在顶层不应该有呼 叫函式、创建物件、或执行不该在使用 pycheck 或 pydoc 时被执行的动作。 编後语 ------ 保持一致 在编修程式时，花几分钟看一看整体的程式码以得知其风格。若所有的运算符旁都有空格 ，你也要空格。若原本的注解旁有用井字圈起来的方格，你的注解也应该加上井字方格。 风格指南的重点在於让写程式设计师在写程式时拥有共通的字汇，所以在编写的过程後能 专注在要写什麽，而非如何去写。我们告诉各位整体的风格规则来让各位了解这些字汇。 然而，个别的风格也是重要的。若你在一个档案中加入了一段风格截然不同的程式片段， 读者们的节奏会被打乱。避免这种事发生。 --

※ 发信站: 批踢踢实业坊(ptt.cc) ◆ From: 68.232.121.105 ※ 编辑: sandwichC 来自: 68.232.121.105 (07/01 01:12)