正则表达式
正则表达式有强大并且标准化的方法来处理字符串查找、替换以及用复杂模式来解析文本。
正则表达式的语法比程序代码更紧凑,格式更严格,比用组合调用字符串处理函数的方法更具有可读性。
还可以在正则表达式中嵌入注释信息,这样就可以使它有自文档化的功能。
匹配符:
^ 匹配字符串开始位置。在多行字符串模式匹配每一行的开头...
分类:
其他好文 时间:
2016-05-23 15:10:58
阅读次数:
216
代码注释及格式化关乎代码的可读性,而代码可读性对于代码可维护性又是至关重要的,因此一些编程的小细节有助于提高代码可维护性。本文列举了一些代码注释及格式化的优秀示例。 一、注释 注释是代码的一部分,其重要性显而易见。缺少注释的代码可以说是没有用的,虽然有人建议使用自文档化代码,不过我们认为自文档化+代...
分类:
其他好文 时间:
2015-10-31 18:29:27
阅读次数:
210
在《人月神话》一书中,提及了软件工程中必备的一个概念:自文档化。所谓自文档化,就是把文档和代码合二为一,既增强了文档的可维护性,又增强了代码的可读性,一举两得,何乐而不为呢?
在Qt开发中,就有这样的自文档化工具:qdoc。使用qdoc,通常分三步走。
第一步,添加QDoc注释到必要的.cpp文件或.qdoc文件,在.h文件中添加QDoc注释是无效的。
第二步,编辑.qdocconf配置文件...
分类:
其他好文 时间:
2015-04-08 15:09:16
阅读次数:
138
原文:How to make your code self-documenting?
译文:怎么让代码自我文档化?
译者:dwqs
在代码中找到一个放错地方并且没有用的注释是不是很有趣呢?
怎么样才能做到写很少的注释但仍能让代码易于理解呢?
一个主要的方式就是让代码自我文档化。当代码自我文档化的时候,就不需要注释去它的作用或者目的,并且也能使代码变得非常容易维护。
在这篇文章中,我将提供一些让你的代码自我文档化的方式。下面就是三种使得代码自文档化的基本方法:
命名:利用名字来解释变量、...
分类:
其他好文 时间:
2014-12-23 12:31:51
阅读次数:
191
[导读] 我们怎么做才能既不需要写很多注释,又能保证代码易于理解呢?其中一个主要的方法就是让代码自文档化。其优势在于,既不用写注释,又能使得代码易于维护。下面就是三种使得代码自文档化的基本方法:命名:利用名...
我们怎么做才能既不需要写很多注释,又能保证代码易于理解呢?
其中一个主要的方法就是让代码自文档化。其优势在于,既不用写注释,又能使得代码易于维护。
下面就...
分类:
其他好文 时间:
2014-12-22 09:35:11
阅读次数:
188