码迷,mamicode.com
首页 > 其他好文 > 详细

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

时间:2019-10-13 17:05:29      阅读:85      评论:0      收藏:0      [点我收藏+]

标签:tin   表示   变量定义   rod   文件   通用   get   字符   条件表达式   

本人工程实践选题是《基于情感词典的大数据分析》,为此我在github上找了一份相关项目的代码并用于进行本文的分析:

目录结构为:

一级:技术图片

 

二级:技术图片

 

三级:词典目录:技术图片

 

           输入数据目录:技术图片

           输出结果目录:技术图片

 

 可见其目录比较清晰,把代码和数据分开,并且训练数据和输出数据也进行了区分,文件名也很好地说明了各个文件的用途,使人一目了然。

 

代码片段:

技术图片

 

 可以看出文件名/类名/函数名/变量名均符合python的规范要求,而且在必要的地方有相应的注释,结构清晰,方便他人进行代码阅读。

 

 代码规范和风格:

基本原则:代码风格的原则是:简明,易读,无二义性。

缩进:一般4个空格。

行宽:行宽必须限制,但是以前有些文档规定的80字符行宽太小了(以前的计算机/打字机显示行宽为80字符),现在时代不同了,可为100字符。

括号:在复杂的条件表达式中,用括号清楚地表示逻辑优先级。

分行:不要把多行语句放在一行上。例如,a = 1; b = 2;    // bogus;更严格地说,不要把不同的变量定义在一行上:Foo foo1, foo2;    // bogus

大小写问题:由多个单词组成的变量名,如果全部都是小写,很不易读,一个简单的解决方案就是用大小写区分它们。Pascal——所有单词的第一个字母都大写;Camel——第一个单词全部小写,随后单词随Pascal格式,这种方式也叫lowerCamel。一个通用的做法是:所有的类型/类/函数名都用Pascal形式,所有的变量都用Camel形式。类/类型/变量:名词或组合名词,如Member、ProductInfo等。函数则用动词或动宾组合词来表示,如get/set; RenderPage()。

注释:复杂的注释应该放在函数头,很多函数头的注释都是解释参数的类型等的,如果程序正文已经能够说明参数的类型in/out等,就不要重复。注释也要随着程序的修改而不断更新,一个误导的(Misleading)注释往往比没有注释更糟糕。另外,注释(包括所有源代码)应只用ASCII字符,不要用中文或其他特殊字符,它们会极大地影响程序的可移植性。

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

标签:tin   表示   变量定义   rod   文件   通用   get   字符   条件表达式   

原文地址:https://www.cnblogs.com/haorw/p/11666944.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!