分析一套源代码的代码规范和风格并讨论如何改进优化代码

我的工程实践题目是文本摘要,下面是github上一套基于keras的代码

  1. 目录文件及其命名

    demo的主体结构,其中有data,very_large_data,models,reports几个模块和主要的函数模块

分析一套源代码的代码规范和风格并讨论如何改进优化代码_第1张图片

  1. 函数名称和变量名称
    • 每行代码的最长字符不超过80个,一屏可以看完,不需要左右移动
    • 本页一级类或方法之间空2行,二级类和方法之间空1行
    • 类命名:所有单词的首字母大写,且不使用特殊字符,下划线,数字
    • 方法命名:全小写字符或者下划线,多单词用下划线连接,但下划线不能做首字符
    • 分析一套源代码的代码规范和风格并讨论如何改进优化代码_第2张图片

    • 常量命名:以大写字母开头且全为大写字母,下划线,数字
    • 分析一套源代码的代码规范和风格并讨论如何改进优化代码_第3张图片

    • 单行注释:# 顶格,空一格后写注释
    • 多行注释:三对双引号或者三对单引号
    • 导入:先导入python包,然后导入第三方包,最后导入自定义包
    • 分析一套源代码的代码规范和风格并讨论如何改进优化代码_第4张图片

    • 空格:赋值和运算符前后各空一格,作为参数符号时候不空格
    • 全局变量名:没有特殊要求,不要使用全局变量

3.关于python的代码其他规范

  • 编码:无特殊情况,一律使用utf-8编码,文件头加入# _*_coding:utf-8_*_

  • 缩进:统一使用4个空格进行缩进

  • 引导:自然预言用"...",机器标识用'...'

  • 空格:在二元运算符两边各空一格,函数的参数,后加空格

  • 文档注释:以"""开头

你可能感兴趣的:(分析一套源代码的代码规范和风格并讨论如何改进优化代码)