Clean Code 代码整洁之道 格式

简介: Clean Code 代码整洁之道 格式

代码整洁之道 第5章 格式 笔记

 

5.1 格式的目的

代码格式关乎沟通

 

5.2 垂直格式

5.2.1 像报纸学习


源文件最顶部应该给出高层次概念和算法,细节应该往下渐次展开。

5.2.2 概念间垂直方向上的分隔

不同的东西用空白隔开。

5.2.3 紧密相连的应该靠近

5.3 横向格式

每行的代码不要过宽,尽量不超过80个字符

5.3.1 水平方向上的分隔与靠近

一段简单的例子:

private void measureLine( String line) {

lineCount++;

int lineSize = line.length();

totalChars += lineSize;

lineWidthHistogram.addLine(lineSize, lineCount);

recordWidestLine(lineSize);

5.3.2 水平对齐

不必过分对齐。

5.3.3 缩进

类中的方法相对类缩进,方法的实现相对方法声明缩进

5.4 团队规则

 

5.5 一个范例

public class CodeAnalyzer implements JavaFileAnalysis {
  private int lineCount;
  private int maxLineWidth;
  private LineWidthHistogram lineWidthHistogram;
  private int totalChars;
  
  public CodeAnalyzer() {
    lineWidthHistogram = new LineWidthHistogram();
  }
  
  public static List<File> findJavaFiles(File parentDirectory) {
    List<File> files = new ArrayList<File>();
    findJavaFiles(parentDirectory, files);
    return files;
  }
  
  private static void findJavaFiles(File parentDirectory, List<File> files) {
    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> widths = lineWidthHistogram.getWidths();
    Integer[] sortedWidths = (widths.toArray(new Integer[0]));
    Arrays.sort(sortedWidths);
    return sortedWidths;
  }
}
 
 



相关文章
|
9月前
代码整洁之道 clean code 读书笔记
代码整洁之道 clean code 读书笔记
|
算法 程序员
《Clean Code》读书笔记
《Clean Code》读书笔记
131 0
|
前端开发 C++
前端知识学习案例1vs code-安装vs code
前端知识学习案例1vs code-安装vs code
85 0
前端知识学习案例1vs code-安装vs code
|
前端开发
前端知识学习案例20vs code-格式化文档
前端知识学习案例20vs code-格式化文档
131 0
前端知识学习案例20vs code-格式化文档
|
前端开发
前端知识学习案例13vs code-添加注释
前端知识学习案例13vs code-添加注释
86 0
前端知识学习案例13vs code-添加注释
|
存储 JSON 数据格式
python 操作 json 文件的种种知识点
Python 提供了内置的 json 模块来处理 JSON 格式的文件。 该模块主要分为读取和写入 JSON 文件。
345 0
|
前端开发 开发工具 git
一篇文章讲清楚关于package.json几点让人迷惑的知识点,建议收藏
一篇文章讲清楚关于package.json几点让人迷惑的知识点,建议收藏
|
Web App开发 JSON 前端开发
用了这 7 个 VS Code 插件,想写一辈子代码
你知道将高级开发人员与普通开发人员区分的条件是什么吗?没错,是所使用的工具,俗话说,"工欲善其事必先利其器", 拥有正确的工作工具可以让开发人员的生活变得更加轻松,甚至想写一辈子代码。
用了这 7 个 VS Code 插件,想写一辈子代码
|
程序员
Clean Code系列之坏味道及重构
几乎在每个团队,都至少有一份代码规范,或者代码的check list。然也就仅仅是一份清单。 每次团队复盘时,都会有一条,我们要写好代码,然“好代码”是什么样子,什么标准,全取决于各人的水平。 每个程序员也都知道code review的重要性,然排期很紧张,难得做一次。宁可花时间追查问题,也不做防御性准备。
338 0