어떻게 소스 코드의 코딩 표준의 설정과 스타일을 분석하고 코드를 최적화하기 위해 개선 사항을 논의하기 위해

  공학 연습 주제는 데이터 수집과 관련된 여기 분석은 마이크로 채널 대중 번호가 소스 코드를 파충류 선택합니다.

소스 코드 디렉토리 구조

 

   디렉토리 구조는 비교적 명확하다

  1.bin 중요한 코드를 기억

  

 

  이러한 인터페이스 설명 설치 설명서, 사용 방법, 환경 등의 설명 문서 2.docs 스토리지

  

 

  여기서 3.wechat, 링크 제어 파충류는 제어 수로, 코드 관리되고

  

 

  4.wechatspider 파충류, URL 수집 및 분석 등의 코드를 저장

  

 

  5. 일부 다른 구성 파일 및 추가 정보

  

 

II. 명명

  1. 파일 이름

  당신은 작은 혹의 명칭, getNewIp.py 첫 번째 단어의 첫 글자를 볼 수있다, 각 단어의 시작 부분의 두 번째 단어는 대문자로

  

 

   2. 클래스의 이름

  큰 고비 명칭을 사용하여 각 단어의 첫 글자는 대문자입니다.

  

 

  3. 함수 이름

  단어의 중간 _로 구분 사용 스네이크 케이스 명명법. 법의 첫 글자에서이 이름 단어는 일반적으로 소문자와 대문자와 소문자 모두의 첫 번째 단어의 첫 글자가 될 수 있습니다.

  

 

스타일의 III. 평가

  우선, 코드의 구조는 다음과 같은 기능, 합리적인 구조에있어서 비교적 명확한 계층 코드 포인트이다.

   전반적으로 명명 규칙은, 사용하는 일반적인 명명 규칙에 맞춰 명칭 세 종류의 조건이 매우 좋다.

  댓글의 수 바로, 매우 합리적인 :  

    

  문서의 시작은 저자를 나타냅니다 :

  

  그러나 단점은이 코드 이름은 폴더 이름 수단으로 구분없는 단어 등 일부 지역 및 일부 비 표준에 나타납니다 있다는 것입니다 :

  

 

IV. 일반 요구 사항 및 스타일 코드 사양

  개인적으로, 파이썬의 용도로 사용, 여기에 일반적인 파이썬 코드 사양을 소개합니다.

  사실 공식 파이썬은 코딩 표준을 제공합니다 : 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