注释

对于模块，类，方法，甚至于某一步骤的算法，处理都需要进行功能注释，逻辑注释，对于注释可以采取一个统一的标准。

• 文件开始使用块注释表明文件实现功能
• 每个类，方法，或者算法之前使用行注释标明功能，超过一行的话使用块注释

Pycharm：

块注释：选中该行，ctrl+/
单行注释，键入三个单引号’‘’后用回车Enter补全
函数注释：函数定义下面键入三个单引号‘’‘后回车Enter补全

IntelliJ IDEA：

单行注释：选中该行，ctrl+/
块注释：键入/*后用回车Enter补全
方法注释：方法定义下面键入/**后回车Enter补全

命名

Python

• 包，模块 都是小写字母，不允许下划线
• 类，首字母大写
• 方法，变量名 全部小写字母，允许下划线连接

Java

• 包，全部小写字母，顶级域名
• 类，首字母大写
• 方法名 动词，驼峰原则
• 变量名 驼峰原则

IDE集成代码检查插件

• Pycharm 自带autopep8插件，可以在Code，Reformat中直接格式化代码，快捷键Ctrl+Shift+Alt+L
• IDEA设置中Plugins中集成Alibaba Java Coding Guidelines 阿里巴巴编码规范：
  • 单个文件，右键，执行编码扫描规范
    
  • 模块扫描，选中模块，执行编码扫描规范，在控制台中输出结果 建议对语言有一定熟悉之后再开启这个功能，否则一堆报错是很头疼的，同样可以用快捷键Ctrl+Shift+Alt+L格式化代码