文章目录 1 规范 1.1 基本规范 1.2 前端编码规范 1.3 日志规范 1.4 代码提交规范 1.5 接口规范 1.6 文件或包的引用 2 代码注释 2.1 Python代码注释 2.2 前端代码注释 3 Python官方风格指南PEP8 3.1 规范代码自动化检查flake8 3.2 规范代码自动化检查black 4 配置文件 4.1 配置文件的必要性 4.2 配置文件格式 4.2.1 格式ini 4.2.2 格式json 5 参考附录 1 规范 1.1 基本规范 一、代码编码 1、国际惯例,文件编码和Python编码格式全部为utf-8 ,例如:在Python代码的开头,要统一加上。 python设置文件编码的方式: 1、使用#coding=<编码名称>的方式设置; 2、使用#-*- coding: <编码名称> -*-的方式设置; # coding=utf-8 # -*- coding: UTF-8 -*- # -*- coding: utf-8 -*- 作用是定义源代码的编码.