原文:How to make your code self-documenting?
译文:怎么让代码自我文档化?
译者:dwqs
在代码中找到一个放错地方并且没有用的注释是不是很有趣呢?
怎么样才能做到写很少的注释但仍能让代码易于理解呢?
一个主要的方式就是让代码自我文档化。当代码自我文档化的时候,就不需要注释去它的作用或者目的,并且也能使代码变得非常容易维护。
在这篇文章中,我将提供一些让你的代码自我文档化的方式。下面就是三种使得代码自文档化的基本方法:
命名:利用名字来解释变量、...
分类:
其他好文 时间:
2014-12-23 12:31:51
阅读次数:
191
MyBatis mybatis和hibernate都属于orm(对象与关系映射) 框架 mybatis的优点: 1.sql-mapping :操作更自由,可控性高,执行效率更高 2.轻量,学习更容易 3.维护和修改容易 mybatis使用场合: 在不需要太多复杂的功能,...
分类:
其他好文 时间:
2014-12-17 12:46:33
阅读次数:
265
把非代码资源(如图片和字符串常量)和代码分离开来始终是一种很好的做法。通过把资源分离开来,可以使它们变得更加容易维护、跟新和管理。一、创建资源应用程序的资源存储在项目层次中res文件夹下1、简单值--res/values支持的简单值包括字符串、颜色、尺寸、样式和字符串数组或者整型数组,所有的简单值都...
分类:
其他好文 时间:
2014-12-13 23:13:20
阅读次数:
212
JSP的3种方式实现radio ,checkBox,select的默认选择值。以radiao 为例:第一种方式:在jsp中使用java 脚本,这个方法最直接,不过脚本太多,不容易维护第二种方式:使用jsp标准标签库jstl:首先需要加入库文件其次为:其中state应该在request,session...
分类:
Web程序 时间:
2014-12-13 23:03:50
阅读次数:
251
在软件面向对象的设计中,我们对于软件的要求越来越高——软件容易扩展,开发效率高、质量高,容易维护。这就要求在进行软件设计的过程中有一定的原则来解决这些问题。在面向对象设计中,可维护性和可复用性是一设计原则为基础的,每个原则都蕴含一些面向对象设计的思想,可以从不同的角度提升一个软件结构的设计水平。
面向对象设计原则为支持可维护性和可复用性而诞生,这些原则蕴含在很多的设计模式中,它们是...
分类:
其他好文 时间:
2014-12-13 18:05:41
阅读次数:
147
pig 提供了一个基于hadoop并行执行数据流处理的引擎,以Pig Latin来描述数据流,相当于一个有向无环图(DAG),节点代表处理数据的操作符,节点间的向量代表数据流。pig 提供了类SQL的标准操作,比直接写mapreduce代码更容易维护,主要用于ETL,原生数据研究和迭代处理。pig 什么数据都吃,也能在非hadoop上并行运算,容易控制和修改,性能较快。用户提交hadoop任务的那...
分类:
其他好文 时间:
2014-12-13 17:58:05
阅读次数:
182
原文地址:http://leihuang.org/2014/12/09/proxy/
Structural 模式 如何设计物件之间的静态结构,如何完成物件之间的继承、实 现与依赖关系,这关乎着系统设计出来是否健壮(robust):像是易懂、易维护、易修改、耦合度低等等议题。Structural 模式正如其名,其分类下的模式给出了在不同场合下所适用的各种物件关系结构。
Def...
分类:
其他好文 时间:
2014-12-12 22:14:03
阅读次数:
184
原文地址:http://leihuang.org/2014/12/09/flyweight/
Structural 模式 如何设计物件之间的静态结构,如何完成物件之间的继承、实 现与依赖关系,这关乎着系统设计出来是否健壮(robust):像是易懂、易维护、易修改、耦合度低等等议题。Structural 模式正如其名,其分类下的模式给出了在不同场合下所适用的各种物件关系结构。
...
分类:
其他好文 时间:
2014-12-12 22:13:52
阅读次数:
280
原文地址:http://leihuang.org/2014/12/09/facade/
Structural 模式 如何设计物件之间的静态结构,如何完成物件之间的继承、实 现与依赖关系,这关乎着系统设计出来是否健壮(robust):像是易懂、易维护、易修改、耦合度低等等议题。Structural 模式正如其名,其分类下的模式给出了在不同场合下所适用的各种物件关系结构。
De...
分类:
其他好文 时间:
2014-12-12 22:13:17
阅读次数:
215
原文地址:http://leihuang.org/2014/12/06/adapter/
Structural 模式 如何设计物件之间的静态结构,如何完成物件之间的继承、实 现与依赖关系,这关乎着系统设计出来是否健壮(robust):像是易懂、易维护、易修改、耦合度低等等议题。Structural 模式正如其名,其分类下的模式给出了在不同场合下所适用的各种物件关系结构。
...
分类:
其他好文 时间:
2014-12-11 19:15:26
阅读次数:
179