java 编程风格指导

《java 编程风格指导》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、1/56.170软件工程试验Java编程风格指导内容：z概要z描述性复合名z缩进和空格的一致z注释信息z注释代码z注释z6.170Javadocs概要编码风格在软件工程实践中起着重要的作用。目的是是使书写的代码简单易懂，减少维护的代价，能在将来更好的扩张和修改。在6.170我们不明确说明你必须要遵守的详细的编码风格。然而，我们希望你的代码简单、易懂。下面这些材料提供了所有的说明，能帮助你形成自己的有效的编码风格。描述性复合名包、类型、变量和分支标签的名字必须代表它们的含义或者用途。这不是意味着这样

2、的名字很长，例如，像i和j得名字是很适合短循环的索引的，因为程序员们根据习惯都理解这些变量的意义和作用的。你应该遵守，Java的类名首字母大写，但方法、域、变量和包名首字母小写。常量的名字每个字母都是大写。Java语言规格提供了一些通用的命名规格，当你要命名类、方法等时可以使用。缩进和空格的一致性代码缩进的一致性能使人们很容易看清if条件和while循环的结束等等。你应该选择始终如一的策略；例如，要始终坚持将大括号和if放在同一行，或者将它放在紧挨着的下一行，try-catch-finally语句

3、块也要始终如一。检验一下课本上的代码是不是一种风格，自由的开发形成你自己的使自己舒服的代码风格。在Emacs的Java模型中，return缩进的行是正确的列，空格键也缩进到正确的行。所有的命令缩进到一片区域中。在eclipse中快捷键Ctrl-F能正确的缩进你的代码。一致的空格也能帮助读者。没有任何理由将你的代码尽可能的挤在尽量少的列中。你应该在你的类函数参数的逗号后留有一定的空格。你应该在for，if，while和左括号中留有一定的空格；否则，声明会看起来很像一个方法调用，这样会令人困惑，一般说

4、来，应该将每一个声明放在单独的一行。2/5注释信息不要犯将注释乱放的错误，这样比没有注释更糟糕和无用。如果信息时非常明显的代码，增加一个注释反而多余，例如，下面就是一个无用的注释：i++;//自增好的注释是向代码中增加简明、清楚的信息。例如，如果注释能够使读者少阅读一些代码，就具备了告知性。下面的注释能节省读者想出特定的复杂公式的时间，表明了程序员的意图，并且公式以后可以检验。//计算列表中小于截断值的所有元素的标注差for(inti=0;i

5、明了函数的参数和返回值，这样客户就不需要阅读代码的隐含含义就能理解怎样使用这个功能来解释一个复杂的步骤或者算法了。这对于那些不是很明显的代码是非常重要的。你应该解释那些令人费解的算法中有副作用的操作，代码中的魔幻数字等等。//信号，一个新的进程完成和就绪的迁移请求。管理线程下次开始硬盘迁移，她来唤醒将要改变的变量。buffer_manager.active_requests++;记录假设.在那个假设下代码正确的执行?//缓冲区至少包含一个字符.（如果这个缓冲区是空的话，中断管理程序将不调用函数返回

6、）c=buffer.get_next_character();3/5不足和不完全代码的记录。通常情况下，第一版代码是不完全了；记录这些代码很重要。如果你用完了所有的假设并要提交这些对所有输入不完武完全正确代码，我们希望你的代码展示出自我理解这些局限。if(n>0){average=sum/n;}else{//XXX以前的迭代需要用到的分解值//从现在起，开始使用任何值average=15;}提示:不要先写代码再写注释—注释随着前进。当你思考你正在书写的代码时并且熟知它们的细节时就很容易注释了，并且

7、你在以后注释了。并不要对每一个程序对象都注释。然而，你的成绩本质上依赖于你代码的清晰度，一些对你来说很清楚的代码对其他读者可未必。因此，我们强烈建议你增加对所有的类、域和方法的注释—这样做对你的优点很有好处。注释代码在Java内，/*和*/被用来注释大块的代码，//被用来注释以//开头的那一行代码。实际上，/*和*/是供Javadoc注释使用(见下节)，在这种情况下开始的标记应附加一个星号：/**。如果你需要注释一大块代码在Eclipse下可以使用快捷键Ctrl+/。这种注释很好，因为注释不在一块

8、。例如，如果你已经这样做了：Stringa="Athena";Stringb="bites";/*Stringb="bringsmehappiness";*/Stringc="closes?Nope.Never.";Stringd="doesn'thaveanywheretosleepcomfortably.";但是当你想要注释变量b和c时，想用块注释，你不得不这样做：Stringa="Athena";/*Stringb="bites";/*Stringb="bringsmehap