这篇文章将与咱们一同聊一聊，书写代码过程中一些杰出的格局标准。
一、导言
以下导言的内容，有必要随同这个系列的每一次更新，这次也不破例。
《代码整齐之道》这本书提出了一个观念：代码质量与其整齐度成正比，洁净的代码，既在质量上牢靠，也为后期保护、晋级奠定了杰出基础。书中介绍的规矩均来自作者多年的实践经验，包括从命名到重构的多个编程方面，虽为一“家”之言，然诚有可资学习的价值。
但咱们知道，许多时分，抱负很饱满，实际很骨感，也知道人在江湖，情不自禁。由于项目的紧迫性，需求的多样性，咱们无法时时刻刻都写出整齐的代码，坚持自己输出的都是高质量、高雅的代码。
但若咱们了解了代码整齐之道的精华，咱们会知道怎样让自己的代码愈加高雅、整齐、易读、易扩展，知道真实整齐的代码应该是怎么样的，或许就会逐渐养成持续输出整齐代码的习气。
而且或许你会发现，若你一向坚持输出整齐代码的习气，长时刻来看，会让你的全体功率和代码质量大大提高。
二、本文触及知识点思想导图
国际惯例，先放出这篇文章所触及内容知识点的一张思想导图，就开端正文。咱们若是疲于阅览文章正文，直接看这张图，也是能够Get到本文的首要知识点的大约。
三、优异代码的书写格局准则
1 像报纸相同一望而知
想想那些阅览量巨大的报纸文章。你从上到下阅览。在顶部，你期望有个头条，告知你故事主题，好让你决议是否要读下去。榜首段是整个故事的纲要，给出粗线条概述，但躲藏了故事细节。接着读下去，细节逐步添加，直至你了解一切的日期、姓名、引语、说话及其他细节。
优异的源文件也要像报纸文章相同。称号应当简略而且一望而知，称号自身应该满足告知咱们是否在正确的模块中。源文件最顶部应该给出高层次概念和算法。细节应该往下逐步打开，直至找到源文件中最底层的函数和细节。
2 恰如其分的注释
带有少数注释的整齐而有力的代码，比带有很多注释的琐细而杂乱的代码愈加优异。
咱们知道，注释是为代码服务的，注释的存在大多数原因是为了代码愈加易读，但注释并不能美化糟糕的代码。
别的，留意一点。注释存在的时刻越久，就会离其所描绘的代码的含义越远，越来越变得全然过错，由于大多数程序员们不能坚持(或许由于忘了)去保护注释。
当然，教育性质的代码，多半是注释越具体越好。
3 适宜的单文件行数
尽或许用几百行以内的单文件来结构出超卓的体系，由于短文件一般比长文件更易于了解。当然，和之前的一些准则相同，仅仅供给大方向，并非不行违反。
例如，《代码整齐之道》第五章中说到的FitNess体系，便是由大多数为200行、最长500行的单个文件来结构出总长约5万行的超卓体系。
4 合理地运用空白行
古诗中有留白，代码的书写中也要有恰当的留白，也便是空白行。
在每个命名空间、类、函数之间，都需用空白行离隔(应该咱们在学编程之初，就早有恪守)。这条极端简略的规矩极大地影响到了代码的视觉外观。每个空白行都是一条头绪，标识出新的独立概念。
其实，在往下读代码时，你会发现你的目光总逗留于空白行之后的那一行。用空白行离隔每个命名空间、类、函数，代码的可读性会大大提高。
5 让严密相关的代码彼此接近
如果说空白行离隔了概念，那么接近的代码行则暗示了他们之间的严密联络。所以，严密相关的代码应该彼此接近。
举个反例(代码段1)：
[csharp] view plain copy print?
public class ReporterConfig
{
/**
* The class name of the reporter listener
*/
private String m_className;
/**
* The properties of the reporter listener
*/
private List
public void addProperty(Property property)
{
m_properties.add(property);
}
}
再看个正面示例(代码段2)：
[cpp] view plain copy print?
public class ReporterConfig
{
private String m_className;
private List
public void addProperty(Property property)
{
m_properties.add(property);
}
}
以上这段正面示例(代码段2)比反例(代码段1)中的代码好太多，它正好一览无遗，一眼就能看这个是有两个变量和一个办法的类。而再看看反例，注释几乎弄巧成拙，隔断了两个实体变量间的联络，咱们不得不移动头部和眼球，才干取得相同的了解度。
6 根据相关的代码散布
关系密切的概念应该彼此接近。关于那些关系密切、放置于同一源文件中的概念，他们之间的区隔应该成为对彼此的易懂度有多重要的衡量标准。应该防止迫使读者在源文件和类中跳来跳去。变量的声明应尽或许接近其运用方位。
关于大多数短函数，函数中的本地变量应当在函数的顶部呈现。例如如下代码中的is变量的声明：
[cpp] view plain copy print?
private static void readPreferences()
{
InputStream is= null;
try
{
is= new FileInputStream(getPreferencesFile());
setPreferences(new Properties(getPreferences()));
getPreferences().load(is);
}
catch (IOException e)
{
DoSomeThing();
}
}
而循环中的控制变量应该总在循环语句中声明，例如如下代码中each变量的声明：
[cpp] view plain copy print?
public int countTestCases()
{
int count = 0;
for (Test each : tests)
count += each.countTestCases();
return count;
}
在某些较长的函数中，变量也或许在某代码块的顶部，或在循环之前声明。例如如下代码中tr变量的声明：
[cpp] view plain copy print?
…
for (XmlTest test : m_suite.getTests())
{
TestRunner tr = m_runnerFactory.newTestRunner(this, test);
tr.addListener(m_textReporter);
m_testRunners.add(tr);
invoker = tr.getInvoker();
for (ITestNGMethod m : tr.getBeforeSuiteMethods())
{
beforeSuiteMethods.put(m.getMethod(), m);
}
for (ITestNGMethod m : tr.getAfterSuiteMethods())
{
afterSuiteMethods.put(m.getMethod(), m);
}
}
…
别的，实体变量应当在类的顶部声明(也有一些门户喜爱将实体变量放到类的底部)。
若某个函数调用了另一个，就应该把它们放到一同，而且调用者应该尽量放到被调用者上面。这样，程序就有天然的次序。若坚定地恪守这条约好，读者将能够坚信函数声明总会在其调用后很快呈现。
概念相关的代码应该放到一同。相关性越强，则彼此之间的间隔就该越短。
这一节的关键收拾一下，大致便是：
变量的声明应尽或许接近其运用方位。
循环中的控制变量应该在循环语句中声明。
短函数中的本地变量应当在函数的顶部声明。
而关于某些长函数，变量也能够在某代码块的顶部，或在循环之前声明。
实体变量应当在类的顶部声明。
若某个函数调用了另一个，就应该把它们放到一同，而且调用者应该尽量放到被调用者上面。
概念相关的代码应该放到一同。相关性越强，则彼此之间的间隔就该越短。
7 团队遵照同一套代码标准
一个好的团队应当约好与遵照一套代码标准，而且每个成员都应当选用此风格。咱们期望一个项目中的代码具有类似乃至相同的风格，像默契无间的团队所完结的艺术品，而不是像一大票定见相左的个人所堆砌起来的残次品。
定制一套编码与格局风格不需要太多时刻，但对整个团队代码风格统一性的提高，却是马到成功的。
记住，好的软件体系是由一系列风格共同的代码文件组成的。尽量不要用各种不同的风格来构成一个项目的各个部分，这样会添加项目自身的杂乱度与紊乱程度。
四、典范代码
和上篇文章相同，有必要贴出一段书中推重的整齐代码作为本次代码书写格局的典范。书中的这段代码选用java言语，但一点点不影响运用C++和C#的朋友们阅览。
[cpp] view plain copy print?
public class CodeAnalyzer implements JavaFileAnalysis
{
private int lineCount;
private int maxLineWidth;
private int widestLineNumber;
private LineWidthHistogram lineWidthHistogram;
private int totalChars;
public CodeAnalyzer()
{
lineWidthHistogram = new LineWidthHistogram();
}
public static List
{
List
findJavaFiles(parentDirectory, files);
return files;
}
private static void findJavaFiles(File parentDirectory, List
{
for (File file : parentDirectory.listFiles())
{
if (file.getName().endsWith(".java"))
files.add(file);
else if (file.isDirectory())
findJavaFiles(file, files);
}
}
public void analyzeFile(File javaFile) throws Exception
{
BufferedReader br = new BufferedReader(new FileReader(javaFile));
String line;
while ((line = br.readLine()) != null)
measureLine(line);
}
private void measureLine(String line)
{
lineCount++;
int lineSize = line.length();
totalChars += lineSize;
lineWidthHistogram.addLine(lineSize, lineCount);
recordWidestLine(lineSize);
}
private void recordWidestLine(int lineSize)
{
if (lineSize > maxLineWidth)
{
maxLineWidth = lineSize;
widestLineNumber = lineCount;
}
}
public int getLineCount()
{
return lineCount;
}
public int getMaxLineWidth()
{
return maxLineWidth;
}
public int getWidestLineNumber()
{
return widestLineNumber;
}
public LineWidthHistogram getLineWidthHistogram()
{
return lineWidthHistogram;
}
public double getMeanLineWidth()
{
return (double)totalChars / lineCount;
}
public int getMedianLineWidth()
{
Integer[] sortedWidths = getSortedWidths();
int cumulativeLineCount = 0;
for (int width : sortedWidths)
{
cumulativeLineCount += lineCountForWidth(width);
if (cumulativeLineCount > lineCount / 2)
return width;
}
throw new Error("Cannot get here");
}
private int lineCountForWidth(int width)
{
return lineWidthHistogram.getLinesforWidth(width).size();
}
private Integer[] getSortedWidths()
{
Set
Integer[] sortedWidths = (widths.toArray(new Integer[0]));
Arrays.sort(sortedWidths);
return sortedWidths;
}
}
五、小结：让代码不仅仅是能作业
代码的格局关乎交流，而交流是专业开发者的头等大事，所以杰出代码的格局至关重要。
或许之前咱们以为“让代码能作业”才是专业开发者的头等大事。但是，《代码整齐之道》这本书，期望咱们能扔掉这个观念。
让代码能作业确实是代码存在的首要含义，但作为一名有寻求的程序员，请你想一想，今日你编写的功用，极或许在下一版中被修正，但代码的可读性却会对今后或许发生的修正行为发生深远影响。原始代码修正之后好久，其代码风格和可读性仍会影响到可保护性和扩展性。即使代码已不复存在，你的风格和律条仍影响深远。
“当有人在阅览咱们的代码时，咱们期望他们能为其整齐性、共同性和优异的细节处理而震动。咱们期望他们高高扬起眉毛，一路看下去，期望他们感触能到那些为之劳动的专业人士们的优异作业素质。但若他们看到的仅仅一堆由酒醉的水手写出的鬼画符，那他们多半会得出结论——这个项目的其他部分应该也是紊乱不胜的。”
所以，各位，在开发过程中请不要仅仅是逗留在“让代码能够作业”的层面，而更要重视自身输出代码的可保护性与扩展性。请做一个更有寻求的程序员。
六、本文触及知识点提炼收拾
整齐代码的书写格局，能够遵照如下几个准则：
榜首准则：像报纸相同一望而知。优异的源文件也要像报纸文章相同，称号应当简略而且一望而知，称号自身应该满足告知咱们是否在正确的模块中。源文件最顶部应该给出高层次概念和算法。细节应该往下逐步打开，直至找到源文件中最底层的函数和细节。
第二准则：恰如其分的注释。带有少数注释的整齐而有力的代码，比带有很多注释的琐细而杂乱的代码愈加优异。
第三准则：适宜的单文件行数。尽或许用几百行以内的单文件来结构出超卓的体系，由于短文件一般比长文件更易于了解。
第四准则：合理地运用空白行。在每个命名空间、类、函数之间，都需用空白行离隔。
第五准则：让严密相关的代码彼此接近。接近的代码行暗示着他们之间的严密联络。所以，严密相关的代码应该彼此接近。
第六准则：根据相关的代码散布。
变量的声明应尽或许接近其运用方位。
循环中的控制变量应该在循环语句中声明。
短函数中的本地变量应当在函数的顶部声明。
关于某些长函数，变量也能够在某代码块的顶部，或在循环之前声明。
实体变量应当在类的顶部声明。
若某个函数调用了另一个，就应该把它们放到一同，而且调用者应该尽量放到被调用者上面。
概念相关的代码应该放到一同。相关性越强，则彼此之间的间隔就该越短。
第七准则：团队遵照同一套代码标准。一个好的团队应当约好与遵照一套代码标准，而且每个成员都应当选用此风格。
本文就此结束。
下篇文章，咱们将持续《代码整齐之道》的精读与演绎，讨论更多的内容。
Best Wish~
