Coding Style Guide

General Style

  • Config your IDE or editors to use white space instead of hard tabs.
    • Eclipse
    • Window->Preferences->Editors->Text Editors->Insert spaces for tabs
    • Window->Preferences->Java->Code Style->Formatter->Edit->Indentation-> Tab policy = "Spaces Only"
    • Existing tabs in the file will prevent spaces in new lines created with Enter.
    • Sublime Text: Preferences -> Settings User ->
    "tab_size": 4,
    "translate_tabs_to_spaces": true,
  • Notepad++: Settings -> Preferences -> Tab Settings -> "Replace by space"
  • Line length in Eclipse
    Window->Preferences->Java->Code Style->Formatter->Edit->Line Wrapping->Max line width: 100
  • Indent for wrapped lines
    Window->Preferences->Java->Code Style->Formatter->Edit->Line Wrapping-> Default indentation for wrapped lines: 1
  • White spaces
  • Separating any reserved word from an open parenthesis ( that follows it on that line, if, for, catch, while.
  • Separating any reserved word from a closing curly brace } that precedes it on that line, such as else or catch
  • Before any open curly brace {
if (a = b) {
       // code
} else {
       // code
}
  • On both sides of any binary or ternary operator.
int name = "Mary"
foreach (int num : array)
  • After ,:; or the closing parenthesis ) of a cast
void funcName(int foo, int bar)
  • Braces
  • Braces are used with if, else, for, do and while statements, even when the body is empty or contains only a single statement.
  • No line break before the opening brace.
  • Line break after the opening brace.
  • Line break before the closing brace.
  • Line break after the closing brace, only if that brace terminates a statement or terminates the body of a method, constructor, or named class. For example, there is no line break after the brace if it is followed by else or a comma.
return new MyClass() {
        @Override public void method() {
            if (condition()) {
                try {
                    something();
                } catch (ProblemException e) {
                    recover();
                }
            } else if (otherCondition()) {
                somethingElse();
            } else {
              lastThing();
            }
        }
};    
  • Line wrapping
  • The prime directive of line-wrapping is: prefer to break at a higher syntactic level
  • When a line is broken at a non-assignment operator the break comes before the symbol.
  • When a line is broken at an assignment operator the break typically comes after the symbol
  • A method or constructor name stays attached to the open parenthesis ( that follows it.
  • A comma , stays attached to the token that precedes it.
        myResult = this.thisIsAVeryLongMethodNameBlaBlaBlaBlaBla(
            parameter1, parameter2, parameter3, parameter4, parameter5, parameter6,
            parameter7, parameter8, parameter9, parameter10, parameter11, parameter12);
  • Exceptions
    • Lines where obeying the column limit is not possible (for example, a long URL in Javadoc, or a long JSNI method reference).
    • package and import statements
    • Command lines in a comment that may be cut-and-pasted into a shell.

[Google Java coding style guide]
(https://google.github.io/styleguide/javaguide.html)

SQL

sql = "SELECT t.name FROM hr.employees t WHERE employee_id = ?";
statement = connection.prepareStatement(sql);
System.out.println("Start: " + new Date());
for(int i=0; i<10000; i++) {
        statement.setInt(1, i);
        resultset = statement.executeQuery();
        if(resultset.next()) {
            name = resultset.getString("name");
            doSomething(name);
        }
        resultset.close();
    }            
System.out.println("End: " + new Date());
statement.close();
String endShowDateSql = "TO_DATE('"+endShowDate+"', 'Month dd, YYYY HH:MI:SS AM')";
sql = StringUtil.replace(sql, "[$END_SHOW_DATE$]", endShowDateSql);
sql = StringUtil.replace(sql, "[$DMA_CODE$]", dmaCode);

Do this:

SQLQuery q = session.createSQLQuery(sql);
q.addScalar("Id_", Type.LONG);
q.addScalar("rank", Type.FLOAT);
QueryPos qPos = QueryPos.getInstance(q);
qPos.add(classNameId);
qPos.add(ArrayUtils.toPrimitive(siteIds.toArray(new Long[siteIds.size()])));
qPos.add(companyId);
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,723评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,485评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,998评论 0 344
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,323评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,355评论 5 374
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,079评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,389评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,019评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,519评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,971评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,100评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,738评论 4 324
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,293评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,289评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,517评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,547评论 2 354
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,834评论 2 345

推荐阅读更多精彩内容