代码可读性、可调式、可维护性

避免魔鬼数字：
- 将数字通过宏定义或者枚举赋予有意义人类可读的字符串名；

0. 可读性

代码可读性，最基本的是变量名、函数名、类名的可读性，其次是语句本身的可读性，最后是代码段逻辑的可读性；
- 反面案例是，有时候我们为了搞懂一个函数，甚至一个变量的含义，要把整个代码段完整地读下来，效率极低；
- 可读性，是尽可能低地降低入门和上手成本；
好的变量名，本身即是一种注释，
尽量多的使用关键字参数（如果语法支持的话）的形式，在函数声明处以及调用处即可获悉各个参数的含义；

1. 代码文件的拆分

将所有的源代码都写在一个文件中，最开始还很清楚，及至到后来，功能不断扩展添加，一个程序源代码的文件可以长达数百万行，那么该代码无论是维护，还是功能添加，还是调试和定位，都是一种灾难；
- 同一个源代码文件的文件拆分；
- 通过置于不同的包进行拆分；
- 业务型代码，逻辑性代码，工具性代码拆分；
- 模块化和层次化：
  - 不同模块之间相互依赖（通信）又相互独立

2. 日志

关键操作，成功或失败一定要给出必要的日志信息，方便在不进行单步调试代码的前提快速定位；

代码可读性、可调式、可维护性相关推荐

禅与计算机科学程序设计艺术：如何通过映射提高你的代码可读性和可维护性？
计算机科学是一门需要创造性思维和技能的学科,它不仅需要我们编写能够工作的代码,还需要我们编写易于理解.修改和维护的代码.在编写高质量代码的过程中,我们需要考虑可读性和可维护性等因素. 禅与计算机科学程 ...
改善代码可读性的5种方法
在本文中,我会列举五条提高代码可读性的原则.这些原则是我在各种项目.团队和组织的实践中总结出来的经验.我希望大家可以从这篇文章中学到一些东西,从而提高代码的可读性. >>>> ...
提高代码可读性：命名技术
提高代码可读性,首推<代码整洁之道>一书.亦可参考 <Java编程规范>. 提高代码可读性直接有利于提高系统的可维护性.如果那些什么事都不做的抽象有什么益处的话,至少它提高了代 ...
5 个改善代码可读性的方法
作者 | Dev by RayRay 译者 | 王强策划 | 李俊辰本文最初发布于 byrayray.dev 网站,经原作者授权由 InfoQ 中文站翻译并分享. 在本文中,我会列举五条提高代码可 ...
如何提升代码可读性？阿里发布16条设计规约
脍炙人口的唐诗"两个黄鹂鸣翠柳,一行白鹭上青天",清爽直接,简明易懂.可读性好的代码也是让人陶醉的,那么如何写出可读性的代码? 近期,<阿里巴巴Java开发手册>推出详 ...
pandas数据处理代码_使用Pandas方法链接提高代码可读性
pandas数据处理代码 We have been talking about using the Pandas pipe function to improve code readability. ...
python函数增强代码可读性_写Python必须知道的这几个代码技巧！你会吗？
Day09 函数的初始函数:函数是以功能为导向,一个函数封装一个功能.登录,注册,文件的改的操作... 函数减少代码的重复性,增强了代码的可读性: 获取任意一个字符串的元素的个数 s1 = &quo ...
提升代码可读性的 10 个技巧
具有较强可读性的代码,能帮助你调试程序,不让自己活得太累. 代码可读性是计算机编程领域中普遍存在的问题.这也是我们成为开发者首先要学习的事情之一.本文会详细介绍在编写强可读性代码时最佳实践中最重要的一 ...
python之代码可读性浅谈
python基础回顾--代码可读性解析篇前言在学习了一门编程语言之后,往往大部分人会急于使用代码实现自己的一些功能进行测试自己的学习情况,这是好的,但是在实际使用中代码却往往不是只给自己看的,或者 ...

代码可读性、可调式、可维护性

0. 可读性

1. 代码文件的拆分

2. 日志

代码可读性、可调式、可维护性相关推荐

最新文章

热门文章