7 注释 Comments
注释虽然写起来很痛苦, 但对保证代码可读性至关重要; 下面的规则描述了如何注释以及在哪注释; 当然也要记住: 注释固然很重要, 但最好的代码本身应该是文档化self-documenting; 有意义的类型名和变量名, 要远胜过要用注释解释的含糊不清的名字;
你写的注释是给代码读者看的: 下一个需要理解你代码的人, 慷慨些吧, 下一个人可能就是你;...
分类:
其他好文 时间:
2015-05-19 13:08:50
阅读次数:
214
1、敏捷开发是在什么样的背景下产生的?其主要特点有哪些?什么时候选择敏捷开发更恰当,为什么?敏捷开发产生的背景:从20世纪70年代到90年代提出并使用的许多软件开发方法都试图在软件构思、文档化、开发和测试的过程中强加某种形式的严格性。在20世纪90年代后期,一些抵制这种严格性的开发人员系统地阐述了他...
分类:
其他好文 时间:
2015-05-19 00:45:55
阅读次数:
144
对象关系映射(ORM)提供了概念性的、易于理解的模型化数据的方法。ORM方法论基于三个核心原则: 简单:以最主要的形式建模数据。 传达性:数据库结构被不论什么人都能理解的语言文档化。 精确性:基于数据模型创建正确标准化了的结构。 典型地,建模者通过收集来自那些熟悉应用程序但不熟练的数据建模者的人的信...
分类:
其他好文 时间:
2015-05-07 12:03:26
阅读次数:
223
目前源码和文档一般都是分开的,我在想为什么 源码不就是最好的文档么?但是一般源码都是文本text的,格式化需要人为统一规范,所以源码中的文档在现实中不是那么的易于实践。而且 源码 不能包括图片、附件、示例代码等资源,这个又是一个难点。后来我突发奇想,为什么不能把xml作为一种合二为一的文档呢?xml...
分类:
其他好文 时间:
2015-04-14 19:41:17
阅读次数:
133
关于Thrift文档化的确是做的不好。摸索了很久才终于把跨linux与windows跨C++与python语言的配置成功完成。以下是步骤:1) Linux下环境配置l 完成thrift所依赖的其他软件包的安装:Boost、libtool、libevent、bison、flex解压boost_1_55...
分类:
编程语言 时间:
2015-04-12 22:24:09
阅读次数:
236
在《人月神话》一书中,提及了软件工程中必备的一个概念:自文档化。所谓自文档化,就是把文档和代码合二为一,既增强了文档的可维护性,又增强了代码的可读性,一举两得,何乐而不为呢?
在Qt开发中,就有这样的自文档化工具:qdoc。使用qdoc,通常分三步走。
第一步,添加QDoc注释到必要的.cpp文件或.qdoc文件,在.h文件中添加QDoc注释是无效的。
第二步,编辑.qdocconf配置文件...
分类:
其他好文 时间:
2015-04-08 15:09:16
阅读次数:
138
天地会珠海分舵注:本来这一系列是准备出一本书的,详情请见早前博文“寻求合作伙伴编写《深入理解 MonkeyRunner》书籍“。但因为诸多原因,没有如愿。所以这里把草稿分享出来,所以错误在所难免。有需要的就参考下吧,转发的话还请保留每篇文章结尾的出处等信息。本文档的目的是去文档化一个客户端请求ADB...
分类:
数据库 时间:
2015-03-16 09:47:18
阅读次数:
127
本文档的目的是去文档化一个客户端请求ADB服务器往adbd守护进程发送文件相关的请求。请查看OVERVIEW.TXT文档去查看(ADB服务器和adbd守护进程)相关信息,查看SERVICES.TXT去学习其他更多的可用请求。...
分类:
数据库 时间:
2015-03-07 20:04:52
阅读次数:
202
大纲 构建 版本控制 部署 单元测试 架构文档化 命名约定 数据库伸缩性 自动化 反馈 实践 引言: 持续集成的前身: 在使用持续集成之前,很多开发团队都是用每日构建(nightly build)。当时,微软使用这个实践很多年了。谁破坏了构建,就要负责监视后续的构建构成,直至发现下一个破坏了构建的人...
分类:
其他好文 时间:
2015-03-03 22:04:13
阅读次数:
411
需求工程:需求涵盖了用户角度和开发人员角度两个方面,其关键在于需求一定要文档化。业务需求定义了软件产品的发展方向、功能范围、目标客户、和价值来源。用户需求只涉及系统的外部行为而不涉及内部特性。功能需求涉及用户或外部系统与该系统之间的交互,一般不考虑实现的细节。非功能需求是从各个角度对系统的束缚和限制...
分类:
其他好文 时间:
2015-03-01 13:13:01
阅读次数:
107