The Elements of Java Style——前言

来源:互联网 发布:c语言调用函数被跳过 编辑:程序博客网 时间:2024/04/23 22:51

前言

ROGUE WAVE是一家销售C++Java软件组件的公司。我们一直在产品中加入源代码,客户经常浏览代码,不仅能知道软件如何运行的,还能知道如何编写好软件。于是我们感觉到一份压力——这可能比大多数公司的压力都要大——要让我们的源代码保持良好的、一致的风格。

 

随着公司的成长壮大,确保所有的程序员都遵守相同的风格成了一件很困难的事。为了做到这一点,公司创始人和首席程序员Tom Keffer编写了一份35页的文档来说明Rogue Wave公司是如何编写C++代码的。我们将这篇文档广泛派发,并确保每位新员工都能获得一份。文档起到了作用。当客户问我们如何保持代码一致性时,我们就告之以Tom的这篇《C++设计、实现和风格指南》,然后给他们一份。文档传播得很快,我们也将Tom的文档变成了一份技术报告。我们派发出去了数千份,收到了非常积极的回应。

 

Java出现时,我们同样认定我们需要一篇类似于《C++ 指南》的文档。一封短信发给了我们内部的javadev@roguewave.com邮箱,信中列出了一些我们应当要采用的Java代码编写准则。这份准则列表最终成了《Rogue Wave Java风格指南》最初的草稿。

 

准则列表越来越长,风格指南也开始看起来越来越像一本真正的书。这时,我们决定出版这篇指南,而不是又发行另一篇Rogue Wave技术报告。令我们吃惊的是,剑桥大学出版社的编辑们认为这是一个非常棒的想法,于是《Java风格要素》诞生了。

 

Scott Ambler是那篇原稿的首批审核人之一,目前是Ronin International公司(www.ronin-intl.com)的总裁。他喜欢出书的想法,建议我们审核一下他已经发表在网上的Java编码标准。我们非常喜欢他的标准,并决定我们应该成为一个团队。本书就是联合了Scott的标准和Rogue Wave风格文档的结果。

 

读者

我们编写的本书适用于所有编写Java代码的人,尤其是作为团队成员编写Java代码的程序员们。对于一个有效率的团队而言,每个人都必须能阅读和理解其他人的代码。保持风格的一致性就是迈向成功的第一步!

 

我们假定你已经掌握了Java和面向对象编程的基础。

 

致谢

本书是团队努力的结果,团队成员远不止7位署名作者。我们要感谢那些对早期《Rogue Wave Java风格指南》以及《Ambysoft公司Java编码标准》进行过审阅以及做出贡献的人。这包括Jeremy SmithTom KefferWayne GramlichPete HandsmanCris Perdue

 

当然,如果没有剑桥大学出版社编辑们的帮助和鼓励,本书也不会问世。我们的编辑,Lothlórien Homet,将Rogue Wave的人员和Scott Ambler团结在一起,所有的一切源于她的春风化雨以及不懈的坚持和推动。感谢Lothlórien 
原创粉丝点击