更精简的代码,更详细的注释,让项目更容易维护

更精简的代码,更详细的注释,让项目更容易维护,因为项目的本质不是代码,是算法,是实现步骤,

如果代码不精简,很臃肿,时间久了,具体实现过程会记忆模糊的,代码臃肿,以后是要花费更多时间读的。

有时可以在写的时候,就一边小重构一下,不要等到以后再重构

一精简重构的一些方式:

1抽取方法:抽取常用的功能,可以放到一些综合工具类里

2抽取变量:尤其是对于要用到很多if-else结构里的变量,可以先定义一个空变量,然后根据不同的情况,

进行赋值。

3砍掉变量:一个复杂系统肯定有很多的对象和变量,其实仔细思考,

有些对象和变量在不影响高内聚低耦合原则,单一原则的情况下,是可以砍掉的

二注释的话,如果没有太复杂的逻辑,就不需要太详细,如果有较多的复杂逻辑,最好多注释一下

时间: 2024-12-19 17:00:24

更精简的代码,更详细的注释,让项目更容易维护的相关文章

如何编写更棒的代码:11个核心要点

作为一个合格的程序员,有太多的理由促使你去编写干净利落且可读性强的代码.最重要的是因为你编写的代码,将来会有很多人一次次地阅读.当你有一天回过头来看自己的代码时,你就会明白编写优雅的代码是多么的重要.另外,如果别人来阅读你编写的代码,你是否想知道别人看到那些烂代码无比抓狂的感受.因此,花多一点的时间去编写优雅的代码,将来说不定会给你节省更多的时间. 那么,如何编写更棒的代码,下面是11条基本规则: 1.保持方法简短扼要 2.永远永远不要将同一个变量用于不同的目的 3.尽可能让变量和方法的名称能够

编写更少量的代码:使用apache commons工具类库

Commons-configuration   Commons-FileUpload   Commons DbUtils   Commons BeanUtils  Commons CLI  Commons Codec   Commons Collections Commons DBCP    Commons HttpClient  Commons IO  Commons JXPath   Commons Lang   Commons Math   Commons Net   Commons Va

如何编写更棒的代码

作为一个合格的程序员,有太多的理由促使你去编写干净利落且可读性强的代码.最重要的是因为你编写的代码,将来会有很多人一次次地阅读.当你有一天回过头来看自己的代码时,你就会明白编写优雅的代码是多么的重要.另外,如果别人来阅读你编写的代码,你是否想知道别人看到那些烂代码无比抓狂的感受.因此,花多一点的时间去编写优雅的代码,将来说不定会给你节省更多的时间. 那么,如何编写更棒的代码,下面是11条基本规则: 保持方法简短扼要 永远永远不要将同一个变量用于不同的目的 尽可能让变量和方法的名称能够描述要实现的

【整洁之道】如何写出更整洁的代码(上)

如何写出更整洁的代码 代码整洁之道不是银弹,不会立竿见影的带来收益. 没有任何犀利的武功招式,只有一些我个人异常推崇的代码整洁之道的内功心法.它不会直接有效的提高你写代码的能力与速度,但是对于程序员的整个职业生涯必然会带来意想不到的好处. 如果你还是一个在校学生,或者是刚工作没多久的"菜鸟",那么很有必要接触一些这方面的知识的.很显然,它会帮助你更快的适应企业级开发的要求. 1. 为什么需要代码更整洁? 在考虑代码整洁的时候,我们需要明确的一个前提是,这里不讨论代码的对错. 关于什么是

编写更少量的代码

在看项目代码的过程中你会发现某些代码完全可以直接用开源框架来减少代码量的,如一些带有until的工具类.一些常用的io操作等; 研究发现一般的应用程序每 1,000 行代码就包含 20 到 250 个 bug!这个度量被称作缺陷密度.因此可得出一个重要的结论:更少的代码意味着更少的缺陷. 个人认为在项目开发过程中最好能有这样的习惯:能用开源框架(开源框架基本都是众多程序员智慧的结晶,经得住考验)就尽量用,最大限度地减少编码量:即当编码处理一些业务逻辑时首先想想或找找有没相关的开源框架,有适合的就

linux国际象棋 棋盘脚本.md(含脚本注释,查看更直观)

linux国际象棋 棋盘脚本.md(含脚本注释,查看更直观) 最终效果: 题目:编写脚本,实现打印国际象棋棋盘 路径:(仅作者) PDF:D:\Download_SD-Date and Bak(D盘 下载)\学习资料\pdf文件\基础知识\15SHELL脚本编程进阶.pdf ? 15SHELL脚本编程进阶.pdf ? 5.编写脚本,实现打印国际象棋棋盘 视频:(仅作者)17.18天 ? 逻辑:(详见代码注释) 1.循环[for done] 深浅 格子. 2.简化 嵌套 第二层 循环[for do

linux 99乘法表脚本.md(含脚本注释,查看更直观)

linux 99乘法表脚本.md(含脚本注释,查看更直观) 最终效果: 题目:编写脚本,实现打印 99乘法表 路径:(仅作者) PDF:D:\Download_SD-Date and Bak(D盘 下载)\学习资料\pdf文件\基础知识\15SHELL脚本编程进阶.pdf ? 15SHELL脚本编程进阶.pdf ? 5.编写脚本,实现打印国际象棋棋盘 视频:(仅作者)17.18天 ? 逻辑:(详见代码注释) 1.分别循环 行数 列数 [for done] . 2.简化 嵌套(C语言 小括号嵌套,

虚拟机极限精简系统XP、7、8.1|体积更小更稳定

一.WinXP 虚拟磁盘(C):5G 系统占用大小:656M 优化列表: 声卡,打印机去掉,无声音(对我来说没用) 禁止一堆无用开机启动项(基本只剩20多项吧) 删除多余右键(基本能删的就删) 去除右下角时间 关闭视频预览 禁用一堆东西(报错,媒体中心等等好多) 禁止外接设置(USB,光盘等等) 利用各种清理工具清理各种注册表,垃圾,字体...... (系统超干净) 二.WIN7 虚拟磁盘(C):5G 系统占用大小:1.49G 优化列表: 声卡,打印机去掉,无声音(对我来说没用) 禁止一堆无用开

掌握解决问题的艺术,学会迭代开发,成为协作开发的专家,然后为写出更好的代码而担忧(转)

很多开发人员普遍犯有一个错误,认为他们的工作就是写代码.这不是一个开发人员要做的事情. 一个开发人员的工作是解决问题. 解决问题的一部分过程通常涉及到写代码,但是这部分工作是非常非常小的.开发有用的东西才花更多时间. 明白如何迭代开发,随着对问题有更好的理解,你才能给难题增加一些小功能,因为从头开发完美的产品是不可能的.不用写代码就能验证功能,因为很明显,写代码是相当昂贵的. 用于测试.评测和抛弃想法的系统也是极其重要的,因为要是没有它,整个开发组将耗费越来越多的精力,还有用来帮助他们执行得更有