どのようにソースコードのコーディング標準のセットとスタイルを分析し、コードを最適化するための改善を議論するために

  エンジニアリングの練習のトピックは、マイクロチャネルのパブリック数爬虫類のソースコードを選択するために、ここでのデータ収集、分析に関連しています。

ソースコードのディレクトリ構造

 

   ディレクトリ構造が比較的明確です

  重要なコードを格納1.bin

  

 

  そのようなインタフェースの記述、インストール手順、使用のための指示書、環境の説明などの文書の2.docsストレージ、

  

 

  ここ3.wechat、リンク制御爬虫類は、コントロールの数として、マネージコードであります

  

 

  4.wechatspider爬虫類、URLの取得と解析、などをコードを保存

  

 

  5.他のいくつかの設定ファイルとREADME

  

 

II。ネーミング

  1.ファイル名

  あなたは小さなこぶの命名法、getNewIp.py最初の単語の最初の文字を見ることができ、各単語の先頭の2番目の単語は大文字

  

 

   2.クラスの名前

  大きなこぶの命名法を使用し、各単語の最初の文字が大文字になります。

  

 

  3.関数名

  単語の途中_で区切って使用スネークケースの命名法、。法律の最初の文字で、この命名言葉は通常、小文字と大文字と小文字の両方の最初の単語の最初の文字をすることができます。

  

 

スタイルのIII。評価

  まず、コードの構造は、以下の機能、合理的な構造によれば、比較的明確な階層コード・ポイントです。

   全体の命名規則は、通常の命名規則に沿った使用条件命名法の3種類の非常に良いです。

  ちょうど、非常に合理的なコメント数:  

    

  ドキュメントの先頭には、著者を示します。

  

  しかし、欠点は、このコード名は、フォルダ名のいずれかの手段で区切られていない言葉のように、いくつかの場所といくつかの非標準、に表示されていることです。

  

 

IV。一般的な要件とスタイルのコードの仕様

  個人的には、パイソンを使用するよりは、ここでは通常のPythonコードの仕様を紹介します。

  実際には、公式のPythonは、コーディング標準を与える:PEP 8    

  これはPEP8の中国語版です。https://blog.csdn.net/ratsniper/article/details/78954852

  もちろん、これは我々すべてが遵守しなければならないが、ほとんどの人がPEP 8コーディングスタイルを使用すると思われるだけで、必須ではないだけで、標準である、それは事実上の標準コーディングスタイルとなっています。これはPEP8を紹介します。

  書類注釈の1始まり

  pycharmは、定義済みのテンプレートをインポートすることができます使用してください。

  打开一个新建的Python文件进行编辑(F4),这个文件中默认有两行代码:作者姓名和工程名称。之所以会出现这两行代码,是因为Python文件在创建时是基于文件模板进行创建的,因此会预定义这两个变量。在settings > file and code templates > python script 选中,然后写入模板语法。效果如下:  

    

 

   2.空格使用

  • 总是在二元运算符两边加一个空格:赋值(=),增量赋值(+=,-=),比较(==,<,>,!=,<>,<=,>=,in,not,in,is,is not),布尔(and, or, not)。
  • 如果使用具有不同优先级的运算符,请考虑在具有最低优先级的运算符周围添加空格。有时需要通过自己来判断;但是,不要使用一个以上的空格,并且在二元运算符的两边使用相同数量的空格。

 

  3.命名方式

  以下是常见的命名方式:

  • b(单个小写字母)
  • B(单个大写字母)
  • lowercase 小写字母
  • lower_case_with_underscores 使用下划线分隔的小写字母
  • UPPERCASE 大写字母
  • UPPER_CASE_WITH_UNDERSCORES 使用下划线分隔的大写字母
  • CapitalizedWords(或者叫 CapWords,或者叫CamelCase 驼峰命名法 —— 这么命名是因为字母看上去有起伏的外观)。有时候也被称为StudlyCaps。
    注意:当在首字母大写的风格中用到缩写时,所有缩写的字母用大写,因此,HTTPServerError 比 HttpServerError 好。
  • mixedCase(不同于首字母大写,第一个单词的首字母小写)

 

  命名约定:

  Names to Avoid 应避免的名字

  永远不要使用字母‘l’(小写的L),‘O’(大写的O),或者‘I’(大写的I)作为单字符变量名。
  在有些字体里,这些字符无法和数字0和1区分,如果想用‘l’,用‘L’代替。

  Package and Module Names 包名和模块名

  模块应该用简短全小写的名字,如果为了提升可读性,下划线也是可以用的。Python包名也应该使用简短全小写的名字,但不建议用下划线。
  当使用C或者C++编写了一个依赖于提供高级(更面向对象)接口的Python模块的扩展模块,这个C/C++模块需要一个下划线前缀(例如:_socket)

  Class Names 类名

  类名一般使用首字母大写的约定。
  在接口被文档化并且主要被用于调用的情况下,可以使用函数的命名风格代替。
  注意,对于内置的变量命名有一个单独的约定:大部分内置变量是单个单词(或者两个单词连接在一起),首字母大写的命名法只用于异常名或者内部的常量。

  Function Names 函数名

  函数名应该小写,如果想提高可读性可以用下划线分隔。
  大小写混合仅在为了兼容原来主要以大小写混合风格的情况下使用(比如 threading.py),保持向后兼容性。

 

   4.PEP8检查

  可以使用PEP8检查代码是否不符合规则

  故意写几行不符合Python编码风格的代码:

import sys, os
from subprocess import Popen, PIPE

def long_function_name(
    var_one, var_two, var_three,
    var_four):
    print(var_one)

  检查是否符合编码规范:

$ pep8 --first test.py
test.py:1:11: E401 multiple imports on one line
test.py:4:1: E302 expected 2 blank lines, found 1
test.py:6:5: E125 continuation line with same indent as next logical line

  可以看到1、4、6行代码不符合规范

  还可以输出不符合规范的代码和原因:

$ pep8 --show-source --show-pep8 test.py

 

おすすめ

転載: www.cnblogs.com/dwtenir/p/11615399.html