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

lcw12356 lcw12356     2023-05-07     330

关键词:

1.结合工程实践选题相关的一套源代码,根据其编程语言或项目特点,分析其在源代码目录结构、文件名/类名/函数名/变量名等命名、接口定义规范和单元测试组织形式等方面的做法和特点

目录结构如下

技术图片

 

 

 

2.列举哪些做法符合代码规范和风格一般要求

1.无论是在“空行”还是在“空格”,都使该开源项目设计的非常易读,代码更清晰;

2.该项目的命名格式遵从帕斯卡命名法,而且名称本身就具有含义,增加了代码的可读性;

3.该项目的缩进严格按照要求,使整体代码更加美观;

 

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

本代码的注释过少,会导致阅读本代码的阅读体验变差。

 

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

Python语言规范

  1. imports 仅仅用做包和模块的导入,包的导入每个尽量独占一行

  2. packages 导入模块尽量使用模块的全路径

  3. Exceptions 必须小心使用

  4. Global variables 避免使用全局变量

  5. Generator 

  6. lambda 函数仅仅适用于一行代码能实现的简单函数

  7. True or False 尽量使用[],‘‘,,0,None来隐式表示False

Python风格规范 

  1、代码编排

    1 缩进:4个空格实现缩进,尽量不使用Tab,禁止混用Tab和空格

    2 行:每行最大长度不超过79,换行可以使用反斜杠()。最好使用圆括号将换行内容括起来,不建议使用“;”

    3 空行:类和top-level函数定义之间空两行;类中的方法定义之间空一行;函数内逻辑无关段落之间空一行;其他地方尽量不要再空行。

    4 空格:括号内的第一个位置,不要空格。紧靠右括号的位置也不要空格。冒号(:)、逗号(,)、分号(;)之前不要加空格。切片木有参数,不要加空格等

    5 括号:对于单元素tuple一定要加,和括号

  2、命名规范

    module_name

    package_name  

    ClassName  

    method_name  

    ExceptionName

    function_name

    GLOBAL_CONSTANT_NAME

    global_var_name

    instance_var_name

    function_parameter_name

    local_var_name

  3、注释规范

    

    1.块注释,在一段代码前增加的注释。在‘#’后加一空格。段落之间以只有‘#’的行间隔。比如:

    # Description : Module config.     #     # Input : None     #     # Output : None

    2. 行注释,在一句代码后加注释。比如:x = x + 1 # Increment x 但是这种方式尽量少使用。

    3. 避免无谓的注释。

  4、编程建议

    1. 字符串拼接,尽量使用join。使用str的方法而不是内置方法。使用startswith或endswith拉检查前缀和后缀

    2. 单例对象,尽量使用is 、is not,不要使用==

    3. 使用is not而不是not is

    4. 使用def来定义函数,而不是将匿名函数赋给某个变量

    5. 尽量使代码整齐,简洁

    6. 使用isinstance()来判断instance的类型

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

1.结合工程实践选题相关的一套源代码,根据其编程语言或项目特点,分析其在源代码目录结构、文件名/类名/函数名/变量名等命名、接口定义规范和单元测试组织形式等方面的做法和特点目录结构如下   2.列举哪些... 查看详情

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

分析一套源代码的代码规范和风格并讨论如何改进优化代码1、结合工程实践选题相关的一套源代码,根据其编程语言或项目特点,分析其在源代码目录结构、文件名/类名/函数名/变量名等命名、接口定义规范和单元测试组织形... 查看详情

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

分析一套源代码的代码规范和风格并讨论如何改进优化代码结合工程实践选题相关的一套源代码,根据其编程语言或项目特点,分析其在源代码目录结构、文件名/类名/函数名/变量名等命名、接口定义规范和单元测试组织形式等... 查看详情

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

1.结合工程实践选题相关的一套源代码,根据其编程语言或项目特点,分析其在源代码目录结构、文件名/类名/函数名/变量名等命名、接口定义规范和单元测试组织形式等方面的做法和特点;我的工程实践选题是关于web网络安全... 查看详情

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

分析一套源代码的代码规范和风格并讨论如何改进优化代码笔者工程实践课题是:基于语音识别的智能聊天机器人设计。本题目需要先研究机器学习的基本方法,用TeansorFlow机器学习库,通过Python构建一个基于LSTM循环神经网络的... 查看详情

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

...nsorflow的风格迁移代码。1、结合工程实践选题相关的一套源代码,根据其编程语言或项目特点,分析其在源代码目录结构、文件名/类名/函数名/变量名等命名、接口定义规范和单元测试组织形式等方面的做法和特点该代码是利用... 查看详情

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

...音识别的人工智能问答系统,在GitHub上找了一套代码 源代码分析:目录结构 命名合理,格式规范。 代码分析选取其中一个函数分析。可以看到在变量命名、函数命名方面符合规范要求,仅有部分运算符号两侧未全部... 查看详情

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

    我的工程实践课题是设计面向特定对象的搜索引擎。我在Github上找到了一套爬取今日头条、网易、腾讯新闻建立的简单搜索引擎。    目录结构、命名:    其目录如下图所示: ... 查看详情

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

结合工程实践选题相关的一套源代码,根据其编程语言或项目特点,分析其在源代码目录结构、文件名/类名/函数名/变量名等命名、接口定义规范和单元测试组织形式等方面的做法和特点;列举哪些做法符合代码规范和风格一般... 查看详情

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

一.结合工程实践选题相关的一套源代码,根据其编程语言或项目特点,分析其在源代码目录结构,文件名、类名,函数名,变量名等命名,接口定义规范等方面的做法和特点:从以下目录结构可见,该源代码结构清晰  ... 查看详情

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

...一些TensorFlow代码并讨论其风格与改进。 一、TensorFlow源代码分析这是一段SSD在tensorflowmodels下实现的代码,目录如下,注释已给出: (1)这个目录中包含README文件让初次接触该代码的人快速了解该代码的结构,official是官... 查看详情

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

...在Github上下载了一个封闭领域的聊天机器人,并据此进行源代码的分析Github地址:https://github.com/dennybritz/chatbot-retrieval/以下是项目的文件目录结构可以看到,文件夹主要分为models,notebooks,scripts三部分,其中,主要的类存放在sc... 查看详情

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

...实现,同时包含有少量的C++类构成,源码目录结构如下:源代码目录下包含9个子文件夹、5个文件;子文件夹:3rdparty  包含第三方的库,比如视频解码用的ffmpeg,jpg、png、tiff等图片的开源解码库。子文件夹:apps  包含进行... 查看详情

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

... 此次选取的代码是智能合约漏洞检测及分析工具Oyente的源代码。一、Oyente   Oyente是melon.fund于2018年10月发布的一款为现有的以太坊智能合约开发人员构建的符号执行工具,以发现智能合约中潜在的安全漏洞。  开发语... 查看详情

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

...的机器学习技术,我参考了人工智能课程的一些教材官方源代码在这里跟大家分享一下自己关于代码风格的一些认知和理解。1.根据其编程语言或项目特点,分析其在源代码目录结构、文件名/类名/函数名/变量名等命名、接口定... 查看详情

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

我的选题是《针对领域知识的中文知识图谱自动化》源码下载:https://codeload.github.com/chizhu/KGQA_HLM/zip/masterKGQA_HLM基于知识图谱的《红楼梦》人物关系可视化及问答系统文件树:app.py是整个系统的主入口templates文件夹是HTML的页面|-ind... 查看详情

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

...选择的课题是信息安全方向,因此本文选择了OpenSSL项目源代码作为分析对象。SSL是利用公开加密技术里面的RSA加密算法来作为用户端与服务器端在传送机密资料时的加密通讯协定。OpenSSL包含一个命令行工具用来完成OpenSSL库中的... 查看详情

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

我的工程实践课题是《物联网网关智能分析引擎》,我所做的是前端开发。基于此,我对Vue.js目录结构进行分析。Vue.js是当下很火的一个JavaScriptMVVM库,它是以数据驱动和组件化的思想构建的。1.Vue.js目录结构结构图如下所示:bu... 查看详情