Recommandé
Contenu connexe
Tendances
En vedette
En vedette (20)
Similaire à Code style 2014-07-18-pub
Similaire à Code style 2014-07-18-pub (20)
Code style 2014-07-18-pub
- 5. 目录 Why Code Style What’s Code Style about How to follow
- 7. WHAT 1、Specification（根据GoogleCodeStyle） 源文件及其结构 格式及注释 声明及命名 2、Best Practice 方法、命名
- 8. 1.1源文件及其结构 1、编码格式：UTF-8 2、换行：UNIX/LINUX 换行 （git设置） 3、import，不使用通配符 4、类成员顺序： A、public – protected – private B、类成员在上，方法在下
- 9. 2.1格式—括号 1、可选大括号也加上 if, else, for, do, while语句一起使用，即使只有一条语句(或是空)，也应该把 大括号写上 2、Kernighan和Ritchie风格 左大括号前不换行 左大括号后换行 右大括号前换行 if (condition()) { try { something(); } catch (ProblemException e) { recover(); } }
- 10. 2.2格式—注释 1、字段 /** xxx */ 2、方法 /** * */ public void push(PaintBoard paintBoard) { doSomething(); }
- 14. 3.1声明 1、每次声明一个变量 不要采用一个声明，声明多个变量。例如 int a, b; 2、不能像C风格一样声明数组 应该是String[] args，而不是 String args[] 3、修饰符顺序 public protected private abstract static final transient volatile synchronized native strictfp
- 16. 3.2命名 4、方法名 方法命名一般使用动词或者动词短语，在JUnit的测试方法中，可以使用下划线，用来 区分测试逻辑的名字经常使用如下的结构：test<MethodUnderTest>_<state> 。例如： testPop_emptyStack 。 5、常量 大写加下划线分隔；一般使用名词或者名词短语命名。 6、变量 非常量的成员变量命名（包括静态变量和非静态变量），采用lowerCamelCase命名； Camel case 命名：XMLHTTPRequest改为XmlHttpRequest 7、参数名 应该避免使用一个字符作为参数的命名方式。
- 17. Best Practice
- 20. 一、命名 4、布尔值 经常以is开头后面跟名称或名称短语 isDigit，isProbablePrime，isEmpty，isEnabled，hasSiblings 缺点是降低逻辑表达式可读性：if isEmpty (if empty) 5、类型转换 使用toType，比如toString，toArray 6、返回视图 使用asType，比如asList 7、返回基本类型 使用typeValue，比如intValue 8、静态工厂 经常使用valueOf，of，getInstance，newInstance，getType，newType
- 22. 一、命名 10、用min，max表示上下限 minInputSize,maxInputSize 11、first，last表示包含的范围 firstDate,lastDate 12、begin,end表示包含-排除的范围 beginDate,endDate 13、动宾结构 描述好所做的全部事情 printDocument, calcMonthlyRevenues 描述好返回值 printer.isReady() 14、计算值限定词加到名字最后 revenueTotal、revenueAverage这样比totalRevenue、averageRevenue更容易 看出命名含义、更有规则性
- 26. 二、函数 9、异常代替错误码 错误码常常暗示这枚举，应变性差，容易造成if嵌套，改用exception，错误处理就能从 主路径代码中分离出来，得到简化。 10、不要使用异常控制循环体 for(Item item : items){ try{ doSomething(item); }catch(Exception e){ continue; } } try{ Iterator<Foo> i = collection.iterator(); while(true){ Foo foo = i.next(); } }catch(NoSuchElementException e){ }
- 27. 二、函数 11、分离try/catch的主体 抽出方法，简洁 12、使用卫述句 void compute(){ Server server=getServer(); if(server==null) return; Client client=server.getClient(); if(client==null) return; Request current=client.getRequest(); if(current==null) return; processRequest(current); }
- 28. 二、函数 13、容器成员提供额外封装 封装增加或删除元素方法，对于返回整个容器，尽量返回不可变类型 List<Book> getBooks(){ return Collections.unmodifiableList(books); } void addBook(Book arrival){ books.add(arrival); } int bookCount(){ return books.size(); } Iterator getBooks(){ return books.iterator(); }
- 30. 二、函数 15、方法命名帮助传参 16、描述化 assertEquals(expected,actual)，让调用者需要注意传入的顺序，有一定的犯错的概率。 assertExpectedEqualsActual(expected,actual)，这样的函数命名，就大大减轻了记忆 参数顺序的负担。 List moduleDependees = module.getDependSubsystems(); String ourSubSystem = subSysMod.getSubSystem(); if(moduleDependees.contains(ourSubSystem )) //does the module from the global .... if(module.getDependSubsystems().contains(subSysMod.getSubSystem()))
- 31. 二、函数 17、防卫式校验 18、慎用可变参数 public Period(Date start, Date end) { if (start.compareTo(end) > 0) throw new IllegalArgumentException( start + " after " + end); this.start = start; this.end = end; } #wrong System.out.println(Arrays.asList(myArray)); #right System.out.println(Arrays.toString(myArray));
- 32. 二、函数 19、for优先于while Iterator<Element> i = c.iterator(); while(i.hasNext()){ doSomething(i.next()); } for(Iterator<Element> i =c.iterator();i.hasNext();){ doSomething(i.next()); } IteratorElement i2 = c2.iterator(); //BUG,拷贝出错了 while(i.hasNext()){ doSomething(i.next()); } //compile error for(IteratorElement i2 =c2.iterator();i.hasNext();){ doSomething(i.next());
- 33. 二、函数 20、for-each优先于for public class NestedIteration { public static void main(String[] args) { CollectionSuit suits = Arrays.asList(Suit.values()); CollectionRank ranks = Arrays.asList(Rank.values()); ListCard deck = new ArrayListCard(); //BUG,NoSuchElementException for (IteratorSuit i = suits.iterator(); i.hasNext(); ) for (IteratorRank j = ranks.iterator(); j.hasNext(); ) deck.add(new Card(i.next(), j.next())); // Preferred idiom for nested iteration on collections and arrays // for (Suit suit : suits) // for (Rank rank : ranks) // deck.add(new Card(suit, rank)); } }
- 34. 二、函数 21、不要修改入参 inputVal是入参，容易理解为不变的，后续修改者可能把它当做不变量用。 public int sample(int inputVal){ inputVal = inputVal * 2; … return inputVal; } public int sample(int inputVal){ int workingVal= inputVal * 2; … return workingVal; }
- 35. 二、函数 22、异常的抽象层次应与方法一致 此处不应该把底层异常抛出去，暴露了实现细节，应该包装为与之在同一层次的异常 class Employee{ public TaxId getTaxId() throws EOFException{ } } class Employee{ public TaxId getTaxId() throws EmployeeDataNotAvailable{ } }
- 36. 二、函数 23、用布尔变量对程序加以文档说明 目的不明确的布尔判断 VS 目的明确的布尔判断 if( (elementIndex 0) || (MAX_ELEMENTS elementIndex) || (elementInddex == lastElementIndex) ){ } finished = (elementIndex 0) || (MAX_ELEMENTS elementIndex) ; repeatedEntry = elementInddex == lastElementIndex ; If (finished || repeatedEntry){ }
- 37. 函数 相对于追求最小化代码行数，一个更好的度量 方法是最小化人们理解它所需的时间。 if (exponent = 0) { return mantissa * (1 exponent); } else { return mantissa / (1 -exponent); } return exponent = 0 ? mantissa * (1 exponent) : mantissa / (1 -exponent);
- 40. 三、循环 3、带退出循环，更容易维护 while(true){ if(rating target){ break; } rating = cal(parm); } rating = cal(param); while(rating target){ rating = cal(param); } 重复的代码，在修改的时 候，常常忘记保持一致
- 41. 三、循环 4、循环内务操作尽量放到循环体内，循环头 仅仅控制条件 while((inputChar = dataFile.getChar()) != EOF_CHAR){ ; } do{ inputChar = dataFile.getChar(); } while( inputChar != EOF_CHAR)
- 46. HOW
- 47. Reference Google Java Code Style
- 48. Reference
- 49. Reference
- 50. Q A