python代码走查

python代码走查清单

1. 代码的注释是否和代码逻辑一致

解释:当代码的注释与代码逻辑不一致时,会对维护和定位问题产生干扰。所以如果走查的代码中包含注释,或者代码本身归属于某个注释的解释范围,均需要核对修改后代码与注释是否一致。

2. 变量的命名是否代表了其作用

解释:变量的命名值得更多的时间投入。如果几个代码段中变量名称一样,但是含义又有些差别,就很容易在后续开发使用中产生故障,并且给代码阅读带来更多麻烦。

3. 关注循环边界值是否符合预期

解释:循环结构中最常见错误,就是边界设置问题。需要检查语法上是否包括代码写下的边界、也需要检查业务逻辑上是否和编码的逻辑边界是否吻合。

4. 关注条件判断逻辑是否充分必要

解释:一个代码段中包含多个相互关联的条件判断、或者包含一个多条件判断语句,需要保持警惕仔细推敲:多条判断语句前后语句判断顺序是否递进充分,多条件但语句中的每一个条件是否必要合在一起是否充分。

5. 输入参数是否进行异常判断

解释:单从软件产品质量上看,防御式编程是具有明显优势的。而且对开发人员的能力要求上也不会过高,避免不同人开发质量差异大的问题。

6. 是否所有执行语句均捕获了异常

解释:对异常流程的处理是产品软件代码质量的主要判断依据之一。为避免主观判断错误和知识漏洞导致的异常未捕获问题,所有涉及IO的操作以及与运行主体之外的交互均需要捕获异常。

7. 全局变量的全局唯一与并发冲突限制

解释:是否保证了全局变量的全局唯一性,避免使用同名的局部变量。如果在并发处理中涉及修改全局属性,那么必须检查冲突解决机制;即读写数据同步问题的解决方案。

to be continue

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,843评论 6 502
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,538评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 163,187评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,264评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,289评论 6 390
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,231评论 1 299
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,116评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,945评论 0 275
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,367评论 1 313
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,581评论 2 333
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,754评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,458评论 5 344
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,068评论 3 327
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,692评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,842评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,797评论 2 369
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,654评论 2 354

推荐阅读更多精彩内容