我需要培养的编程风格

本文分析了jdk源代码String.class 的代码规范.

 

   接触java有两年多了,真正的开发也只有不到3个月. 看平台代码才知道,自己的差距还是很远的. 各式各样的风格都有,这是与好的程序员的差距.从今天开始,我要树立自己的代码风格,模板为jdk源代码. 一些基本的规范就不列举了.

 

1.空格

(1) 关于=号, 对变量赋值时,按照jdk源码 = 两端加两个空格,如

int size = original.count;

 (2)对于关系运算符(> < == ..) 两端也加空格

if (offset < 0) {

  (3) 方法后 加空格然后{

  public String() {

 (4)对于多个参数间,参数间逗号后加空格

	System.arraycopy(value, 0, v, 0, size);

 (5) if语句中 括号() 外面两侧都加一个空格

if (offset < 0) {

 2 空行

(1)pakage上下各一空行

(2)所有import中没有空行

(3)成员变量间有一空行

(4)连个方法间有一空行

 

3.注释

(1)类注释:写出类的功能, 其它格式见下,如author, 日期格式: MM/DD/YYYY

/**
 * The <code>String</code> class represents character strings. All
 *
 * @author  Lee Boynton
 * @author  Arthur van Hoff
 * @version 1.189, 10/21/05
 * @see     java.lang.Object#toString()
 * @see     java.lang.StringBuffer
 * @see     java.lang.StringBuilder
 * @see     java.nio.charset.Charset
 * @since   JDK1.0
 */

 (2)成员变量的注释:单行使用/** comment .*/ ( 注意标点)

  /** The value is used for character storage. */
    private final char value[];

 (3)方法注释: 首行写出方法作用,

 参数行通过@param 参数变量 参数注释.

异常 @exception 异常名 注释

返回  @return 注释

 /**
     * Allocates a new <code>String</code> that contains characters 
     * @param      value    array that is the source of characters.
     * @param      offset   the initial offset.
     * @param      count    the length.
     * @exception  IndexOutOfBoundsException  if the 
     *        the bounds of the <code>value</code> array.
     */
    public String(char value[], int offset, int count) {
  

 (5)单行注释

//和下面if 竖直对齐

        // Argument is a String
        if (cs.equals(this))

 

评论

31 楼 jack547155187 2011-02-17  

eclipse有快捷键用于调整代码格式

30 楼 lzl836 2011-02-17  

虽然ctrl+shift+f 能搞定，但是我还是比较赞同平时写代码的时候就注意这些细节，注意了细节，会避免不该出现的错误。

29 楼 1927105 2011-02-17  

恩，说的还是比较可以了

28 楼 dkmilan 2011-02-17  

ctrl+shirt+F就能做到
真正需要注意的是你写出程序的风格，而不是代码本身的风格

27 楼 NanguoCoffee 2011-02-17  

li2005 写道

我还是赞同楼主养成好的编码习惯，在有些情况下，我不赞同楼上几们说用ctrl+shift+f来格式化代码。因为现在的项目基本都有版本管理软件，如SVN，有时一个类，自己根本就没有修改，只是用ctrl+shift+f来格式化代码，这就会导致SVN认为这一个版本的类和上一个版本的类有很大的不同

只对修改的代码进行格式化：
方法1:手动选择刚修改的代码，ctrl+shift+f
方法2:eclipse可以配置成在保存时只格式化刚修改过的代码。 这就不需要按ctrl+shift+f， ctrl+s 就直接帮你格式化了。

26 楼 hjg1988 2011-02-17  

如果仅仅是格式的话，用eclipse的格式化功能就不错了。
关于注释，我引用这位同学的话

Loudyn 写道

ctrl+shift+f....
比代码格式整齐更重要的是，命名。
好的代码可读性都很高，这是一个要努力的方向。
至于写不写注释，这个要认真考虑。
可能你今天改了代码，但忘记更新注释，这说不定会让后来维护你代码的人产生误解。
如果你加了注释，那么你要认真维护你所写的注释。
个人觉得，用代码说明你的意图远远比写乱七八糟的代码然后试图通过加注释来解释你的意图好得多。
至于

/**
* set the xxx
*/
public void setXXX(T obj);

这种注释，加了纯粹是废话。
而

/**
* @param obj
*/
public void setXXX(T obj);

这种注释，只是为了方便生成javadoc，要加也很方便，不加也不会怎样

25 楼 Loudyn 2011-02-17  

li2005 写道

我还是赞同楼主养成好的编码习惯，在有些情况下，我不赞同楼上几们说用ctrl+shift+f来格式化代码。因为现在的项目基本都有版本管理软件，如SVN，有时一个类，自己根本就没有修改，只是用ctrl+shift+f来格式化代码，这就会导致SVN认为这一个版本的类和上一个版本的类有很大的不同

没修改，那又何苦手多，按多下ctrl+shift+f呢

24 楼 kyfxbl 2011-02-17  

良好的编程风格不是说段落样式的吧。。。是命名和一些最佳实践之类的

段落格式，缩进什么的。。。你ctrl+shift+F就行了

23 楼 qdpurple 2011-02-17  

li2005 写道

我还是赞同楼主养成好的编码习惯，在有些情况下，我不赞同楼上几们说用ctrl+shift+f来格式化代码。因为现在的项目基本都有版本管理软件，如SVN，有时一个类，自己根本就没有修改，只是用ctrl+shift+f来格式化代码，这就会导致SVN认为这一个版本的类和上一个版本的类有很大的不同

谢谢支持. 养成良好的编程风格我会注意的. 争取以后做到写代码时,不用format就可以写出和使用format的效果.

22 楼 qdpurple 2011-02-17  

Crusader 写道

superwwt 写道

Crusader 写道

额。。去看看林锐的《高质量C++/C编程指南》吧

人家java还没入门呢你让人家看高质量CPP。。。这不坑人呢么……

晕，这篇文主要是着重编程风格/习惯的。。何况java本来就类c的，看不懂真的说不过去

我在baidu百科下了一个 ,大体看了一下,是的里面介绍较多的编程风格,  有空我会看看的. 谢谢大家的讨论.

21 楼 zhaolei415 2011-02-17  

Loudyn 写道

qdpurple 写道

Loudyn 写道

akunamotata 写道

Loudyn 写道

个人觉得，用代码说明你的意图远远比写乱七八糟的代码然后试图通过加注释来解释你的意图好得多。

这里不得不谈下重构，一个好的方法名远比注释来的重要，如果一个方法名不能够很好的被理解，那么...你需要重构你的代码了...

是的。好的代码都是通过不断的重构而来的。
我想，谁也不能从一开始就写对代码写好代码。

谢谢大家的评论，我现在也支持好的命名更重要的。
我想问下 代码重构是什么意思 ？

你可以去看看martin fowler重构一书。

正解！

20 楼 li2005 2011-02-17  

我还是赞同楼主养成好的编码习惯，在有些情况下，我不赞同楼上几们说用ctrl+shift+f来格式化代码。因为现在的项目基本都有版本管理软件，如SVN，有时一个类，自己根本就没有修改，只是用ctrl+shift+f来格式化代码，这就会导致SVN认为这一个版本的类和上一个版本的类有很大的不同

19 楼 qdpurple 2011-02-17  

Crusader 写道

至于命名规范，不用那么死，但最好和工作环境中其他人一致
建议可以了解下匈牙利命名法

我百度百科看了一下 匈牙利命名法 , 感觉在java中没有怎么遵守它,应该在donet中,比较流行吧

18 楼 qdpurple 2011-02-17  

aa87963014 写道

真是服了

ctrl+shift+f加上一个良好的命名 再加上一个注释

搞得这么麻烦 真是有闲情

经过大家点拨,我明白了, 代码风格可以用Eclipse 的format解决. 应注意一个良好的命名和注释 . 

17 楼 Crusader 2011-02-17  

至于命名规范，不用那么死，但最好和工作环境中其他人一致
建议可以了解下匈牙利命名法

16 楼 Crusader 2011-02-17  

superwwt 写道

Crusader 写道

额。。去看看林锐的《高质量C++/C编程指南》吧

人家java还没入门呢你让人家看高质量CPP。。。这不坑人呢么……

晕，这篇文主要是着重编程风格/习惯的。。何况java本来就类c的，看不懂真的说不过去

15 楼 superwwt 2011-02-17  

Crusader 写道

额。。去看看林锐的《高质量C++/C编程指南》吧

人家java还没入门呢你让人家看高质量CPP。。。这不坑人呢么……

14 楼 ilovebaby0530 2011-02-17  

hk8082 写道

归根到底就是要养成一种好的编程书写习惯，平时多注意一下就OK了。
还有那个ctrl+shift+f定义的格式能自己改一下吗？
有时一用，比较整齐的代码，反而变得有点乱了，还不清楚怎样改，有知道的麻烦告诉一声。

java>>code style>> formatter

13 楼 aa87963014 2011-02-17  

真是服了

ctrl+shift+f加上一个良好的命名 再加上一个注释

搞得这么麻烦 真是有闲情

12 楼 Loudyn 2011-02-17  

hk8082 写道

归根到底就是要养成一种好的编程书写习惯，平时多注意一下就OK了。
还有那个ctrl+shift+f定义的格式能自己改一下吗？
有时一用，比较整齐的代码，反而变得有点乱了，还不清楚怎样改，有知道的麻烦告诉一声。

可以的，我用myeclipse8.5,是这样设置的：
window-->preference-->java-->codestyle-->formatter。再点new，新建一个，你可以自己设定代码每一行的长度之类的东西