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

Posted 2023-01-02 muddyway

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了分析一套源代码的代码规范和风格并讨论如何改进优化代码相关的知识，希望对你有一定的参考价值。

源码下载：

git clone https://github.com/lemonhu/stock-knowledge-graph.git

stock-knowledge-graph

A small knowledge graph (knowledge base) construction using data published on the web.
利用网络上公开的数据构建一个小型的证券知识图谱（知识库）。

tree:

├── build_csv.py
├── data
│?? ├── executive_prep.csv
│?? ├── import
│?? │?? ├── concept.csv
│?? │?? ├── executive.csv
│?? │?? ├── executive_stock.csv
│?? │?? ├── import.report
│?? │?? ├── industry.csv
│?? │?? ├── stock_concept.csv
│?? │?? ├── stock.csv
│?? │?? └── stock_industry.csv
│?? ├── stock_concept_prep.csv
│?? ├── stock_industry_prep.csv
│?? └── stockpage.zip
├── design.png
├── extract.py
├── img
│?? ├── executive_detail.png
│?? ├── executive.png
│?? └── stock_graph_demo.png
├── import.report
├── import.sh
├── LICENSE
├── README.md
├── requirements.txt
├── result.txt
├── Review prediction with Neo4j and TensorFlow.md
├── ssr.sh
└── stock.py

├── data：处理好的neo4j关系型数据库数据集

│ ├── import：以csv格式保存的关系型数据库预处理数据集

├── img：媒体文件，以图片文件为主

├── build_csv.py ：从预处理csv建立csv处理后数据集

├── extract.py：提取公司或者股票中的经理

├── stock.py：获取并保存股票上市公司行业分类信息、获取并保存股票上市公司行业概念信息

文件名函数命名规范：

extract、build_csv、 stock_concept_prep.csv、stock_concept.csv、Review prediction with Neo4j and TensorFlow.md

等均使用较为准确描述其功能的小写字母命名，除了readme文件，均以短下划线为分割，清晰易懂。如stock_concept_prep.csv，使人准确知道这是股票与概念之间联系预处理数据集的csv文件。stock_graph_demo.png使人准确知道这是股票演示图的示范图片文件，对于媒体文件的准确命名是很多项目疏忽或者难以耗费精力完成的地方，作者对媒体文件命名规范准确难得。

类命名延续了文件命名小写字母+下划线分割的做法，build_executive表示建立可以被neo4j识别的csv文件，清晰易懂。下划线法是c出现后开始流行起来的，在许多旧的程序和UNIX这样的环境中，它的使用非常普遍。

接口规范：

接口不仅有对函数功能的说明，也有对参数类型及内容的描述。

def extract(stockpage_dir, executive_csv):
    """Extract executive of the comnpany or stock

    Args:
        stockpage_dir: (str) the directory of stock pages
        executive_csv: (str) the full path of the CSV file to be saved
    """

stockpage_dir = './data/stockpage'
directors_csv = './data/executive_prep.csv'
extract(stockpage_dir, directors_csv)

def get_md5(string):
    """Get md5 according to the string
    """
    return restult #string type

def build_executive(executive_prep, executive_import):
    """Create an 'executive' file in csv format that can be imported into Neo4j.
    format -> person_id:ID,name,gender,age:int,:LABEL
    label -> Person
    """
    return None

def build_stock(stock_industry_prep, stock_concept_prep, stock_import):
    """Create an 'stock' file in csv format that can be imported into Neo4j.
    format -> company_id:ID,name,code,:LABEL
    label -> Company,ST
    """

def build_concept(stock_concept_prep, concept_import):
    """Create an 'concept' file in csv format that can be imported into Neo4j.
    format -> concept_id:ID,name,:LABEL
    label -> Concept
    """

单元测试组织形式

作者将工程切割为6个单元分别测试，模块间耦合性在作者代码重构下被分为多个文件后有所降低，可单独进行测试：

从?页中抽取董事会的信息、获取股票行业和概念的信息、设计知识图谱、创建可以导?Neo4j的csv文件、

利用上面的csv文件生成数据库、基于构建好的知识图谱，通过编写Cypher语句回答如下问题。

使用logs:记录出错详细信息，便于分析：

Id '50371a2c5078b757a8f8c75b8877e815' is defined more than once in group 'global id space'

使用requestments，指导其他用户测试时快速搭建环境：

lxml
pandas
beautifulsoup4
tushare

使用beta测试改进两个用户提交的错误：

1.IndexError: list index out of range

2.Id ‘xxx‘ is defined more than once in group ‘global id space‘

基于MD5的实体唯一性确定规则，这里的两个姚波应该属于同一个人，不应该有重复的ID(实际上重复也不会有影响)。

列举哪些做法有悖于“代码的简洁、清晰、无歧义”的基本原则，及如何进一步优化改进：

? 1. 部分模块没有使用面向对象的思想，个别变量命名只有一个单词，表意不够直观。

　2. 对函数接口没有返回类型要求的描述，代码读者需要从函数调用实际情况观察。接口不完全统一，无法直接生成接口帮助文档。

? 3. 对于各个模块没有完整的注释，尽管划分模块降低耦合但模块间依然存在多种依赖关系。

总结同类编程语言或项目在代码规范和风格的一般要求：

文件目录清晰合理，文件命名基本体现文件功能。
文件或函数接口命名采用驼峰或下划线命名。
文档内容缩进合理，不能空格tab混用。
开头加上coding: utf-8 防止中文显示乱码
函数接口有参数内容类型和返回类型说明，有对函数说明，最好能生成统一性文档
使用基本设计模式降低模块耦合，并对函数间数据流流向有较好把握和控制。

以上是关于分析一套源代码的代码规范和风格并讨论如何改进优化代码的主要内容，如果未能解决你的问题，请参考以下文章

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

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

stock-knowledge-graph

文件名函数命名规范：

接口规范：

单元测试组织形式

相关规范：

列举哪些做法有悖于“代码的简洁、清晰、无歧义”的基本原则，及如何进一步优化改进：

总结同类编程语言或项目在代码规范和风格的一般要求：