《Google Java Style》.pdf

go o gle -st y le guide .go o gle co de .co m http://go o gle-styleguide.go o gleco de.co m/svn/trunk/j avaguide.html Google Java Style 1 Int roduct ion T his do cument serves as t he complet e def init io n of Googles coding st andards f o r so urce code in t he Java ™ rogramming Language. A Java so urce f ile is described as being in Google Style if and o nly if it adheres t o t he rules herein. Like ot her programming style guides , t he iss ues covered s pan not o nly aest het ic iss ues of f o rmatt ing, but ot her types of co nvent io ns o r coding st andards as well. However, t his do cument f o cuses primarily o n t he hard-and-f ast rules t hat we f o llow universally, and avo ids giving advice t hat is nt clearly enf o rceable (whet her by human o r t oo l). 1.1 Te rminology not es In t his do cument , unless ot herwise clarif ied: 1. T he t erm class is used inclus ively t o mean an o rdinary class , enum class , int erf ace o r annot at io n type ( @int erf ace). 2. T he t erm comment always ref ers t o implementation co mment s . We do not use t he phrase do cument at io n co mment s, inst ead us ing t he co mmo n t erm Javado c. Ot her t ermino logy not es will appear o ccas io nally t hro ugho ut t he do cument . 1.2 Guide not es Example code in t his do cument is non- normat ive . T hat is , while t he examples are in Google Style, t hey may not illust rat e t he only stylis h way t o represent t he code. Opt io nal f o rmatt ing cho ices made in examples s ho uld not be enf o rced as rules . 2 Source f ile basics 2.1 File name T he so urce f ile name co ns ist s of t he case- sens it ive name of t he t o p- level class it co nt ains , plus t he .java ext ens io n (as ide f ro m package- inf o.java f iles ). 2.2 File e ncoding UT F-8 So urce f iles are encoded in UT F-8. 2.3 Special charact e rs 2.3.1 Whit espace charact e rs As ide f ro m t he line t ermina