先明确一下，代码格式很重要。代码格式不可忽略，必须严肃对待。代码格式关乎沟通，而沟通是专业开发者的头等大事。
或许你认为“让代码能工作”才是专业开发者的头等大事。然而，我希望本书能让你抛掉那种想法。你今天编写的功能，极有可能在下一版本中被修改，但代码的可读性却会对以后可能发生的修改行为产生深远影响。原始代码修改之后很久，其代码风格和可读性仍会影响到可维护性和扩展性。即便代码已不复存在，你的风格和律条仍存活下来。
那么，哪些代码格式相关方面能帮我们最好地沟通呢？
有可能用大多数为200行、最长500行的单个文件构造出色的系统（FitNesse总长约50000行）。尽管这并非不可违背的原则，也应该乐于接受。短文件通常比长文件易于理解。
想想看写得很好的报纸文章。你从上到下阅读。在顶部，你期望有个头条，告诉你故事主题，好让你决定是否要读下去。第一段是整个故事的大纲，给出粗线条概述，但隐藏了故事细节。接着读下去，细节渐次增加，直至你了解所有的日期、名字、引语、说法及其他细节。源文件也要像报纸文章那样。名称应当简单且一目了然。名称本身应该足够告诉我们是否在正确的模块中。源文件最顶部应该给出高层次概念和算法。细节应该往下渐次展开，直至找到源文件中最底层的函数和细节。
报纸由许多篇文章组成：多数短小精悍。有些稍微长点儿。很少有占满一整页的。这样做，报纸才可用。假若一份报纸只登载一篇长故事，其中充斥毫无组织的事实、日期、名字等，没人会去读它。
方法和方法之间，可以通过空行隔开，方法内部，也可以根据具体的业务逻辑通过空行隔开
看一个例子
public class BoldWidget extends ParentWidget{
public static final String REGEXP ="""'.+?'""";
private static final Pattern pattern=Pattern.compile ("*"'(.+?) 'y'",
Pattern.MULTILINE +Pattern.DOTALL);
public BoldWidget(ParentWidget parent,String text) throws Exception{
super(parent);
Matcher match=pattern.matcher(text);
match.find();
addchildWidgets(match.group(1));
public String render() throws Exception{
StringBuffer html = new StringBuffer("");
html.append(childHtml()).append("");
return html.tostring();
}
}
public class BoldWidget extends ParentWidget{
public static final String REGEXP ="""'.+?'""";
private static final Pattern pattern=Pattern.compile ("*"'(.+?) 'y'",
Pattern.MULTILINE +Pattern.DOTALL);
public BoldWidget(ParentWidget parent,String text) throws Exception{
super(parent);
Matcher match=pattern.matcher(text);
match.find();
addchildWidgets(match.group(1));
public String render() throws Exception{
StringBuffer html = new StringBuffer("");
html.append(childHtml()).append("");
return html.tostring();
}
}
如果说空白行隔开了概念，靠近的代码行则暗示了它们之间的紧密关系。所以，紧密相关的代码应该互相靠近。注意代码清单5—3中的注释是如何割断两个实体变量间的联系的。
看一个例子：
public class ReporterConfig{
/**
* The class name of the reporter listener
*/
private String m_className;
/**
*The properties of the reporter listener
*/
private List<property> m_properties = new ArrayList<Property>();
public void addproperty(Property property){
m_properties.add(property);
}
}
public class ReporterConfig{
private String m_className;
private List<property> m_properties = new ArrayList<Property>()
public void addproperty(Property property){
m_properties.add(property);
}
}
实体变量应该在类的顶部声明。
变量声明应尽可能靠近其使用位置。
循环中的控制变量应该总是在循环语句中声明。
概念相关。概念相关的代码应该放到一起。相关性越强，彼此之间的距离就该越短。
相关函数。若某个函数调用了另外一个，就应该把它们放到一起，而且调用者应该尽可能放在被调用者上面。这样，程序就有个自然的顺序。
一般而言，我们想自上向下展示函数调用依赖顺序。也就是说，被调用的函数应该放在执行调用的函数下面＇。这样就建立了一种自顶向下贯穿源代码模块的良好信息流。
一行代码字符上限是120
参数之间通过空格隔开、另一方面，我不在函数名和左圆括号之间加空格。这是因为函数与其参数密切相关，如果隔开，就会显得互无关系。我把函数调用括号中的参数一一隔开，强调逗号，表示参数是互相分离的。
private void measureLine(String line) {
lineCount++;
int lineSize=line.length();
totalChars+=linesize;
linewidthHistogram.addLine(lineSize, lineCount);
recordwidestLine(lineSize);
}
空格字符的另一种用法是强调其前面的运算符
public class Quadratic{
public static double rootl(double a, double b, double c){
double determinant=determinant(a,b,c);
return (-b + Math.sqrt(determinant)) / (2*a);
}
public static double root2(int a, int b, int c){
double determinant-determinant(a, b, c);
return (-b - Math.sqrt(determinant)) / (2*a);
}
private static double determinant(double a, double b,double c){
return b*b - 4*a*c;
}
}
看看这些等式读起来多舒服。乘法因子之间没加空格，因为它们具有较高优先级。加减法运算项之间用空格隔开，因为加法和减法优先级较低。
不幸的是，多数代码格式化工具都会漠视运算符优先级，从头到尾采用同样的空格方式。在重新格式化代码后，以上这些微妙的空格用法就消失殆尽了。
public class IOSReleaseVersionDetailPO extends BasePO {
private String applicationId;
private Long appRegisterId;
private Long projectId;
private String version;
private IOSReleaseStatusEnum releaseStatus;
private IOSReleaseStepStatusEnum releaseStepStatus;
private IOSPhasedReleaseIsOpenEnum openPhasedRelease;
private IOSAppStorePhasedReleaseStatusEnum phasedReleaseStatus;
private IOSPhasedReleaseDayEnum phasedReleaseDay;
private String operator;
private List<Integer> latestReleasePath;
private String errorMsg;
}
public boolean syncReleaseVersionLanguage(Long versionId, String apiKeyId) {
IOSReleaseVersionDetailPO versionDetail = iOSReleaseVersionDetailDAO.getById(versionId);
List<IOSAppStoreLanguageDTO> appStoreLanguages = fastlaneProxy.getAppStoreReleaseLanguage(versionDetail.getApplicationId(), apiKeyId);
if (CollectionUtils.isEmpty(appStoreLanguages)) {
return Boolean.FALSE;
}
List<IOSReleaseCopyWritingDTO> copyWritings = appStoreLanguages.stream()
.map(appStoreLanguage -> getIOSReleaseCopyWritingDTO(versionId, appStoreLanguage))
.collect(Collectors.toList());
return iOSReleaseCopyWritingService.updateCopyWriting(copyWritings);
}
有时，while或for语句的语句体为空，如下所示。我不喜欢这种结构，尽量不使用。如果无法避免，就确保空范围体的缩进，用括号包围起来。我无法告诉你，我曾经多少次被静静安坐在与while 循环语句同一行末尾的分号所欺骗。除非你把那个分号放到另一行再加以缩进，否则就很难看到它。
while (dis.read(buf, 0,readBuffersize) != -1) {
}
每个团队有不同的团队编码风格，遵循团队的编码风格，同时尽量遵循阿里代码规范