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;
  }
}
 
 



相关文章
|
8月前
|
算法 程序员 编译器
美丽的代码:规范go应用代码注释
【6月更文挑战第30天】本文介绍注释应与代码同步,避免误导,且关键点解释。使用LLVM构建编译器示例展示Go语言规范。注释虽有局限,但在解释复杂逻辑、业务规则时仍有其价值。程序员需平衡注释与代码的关系,创造更优的代码。
1118 0
美丽的代码:规范go应用代码注释
|
8月前
代码整洁之道 clean code 读书笔记
代码整洁之道 clean code 读书笔记
|
Web App开发 缓存 自然语言处理
60 个神级 VS Code 插件!(2)
60 个神级 VS Code 插件!(2)
441 0
60 个神级 VS Code 插件!(2)
|
算法 程序员
《Clean Code》读书笔记
《Clean Code》读书笔记
128 0
|
程序员 开发者
程序员在写code和做管理二者选择时,要切合自身实际来定
写代码还是做管理,这是个老生常谈的命题,就像某明星被离婚一样,隔一段时间就会被提出来供大家讨论。虽然这次话题是这个命题,那就好好的再来聊一次程序员的职业生涯是一直写代码呢还是从写代码转到做管理呢?再借用莎士比亚写的哈姆雷特经典桥段:“生存还是毁灭,这是个问题”,这里我来改编一下:“写代码还是做管理,这是个问题”。
106 0
程序员在写code和做管理二者选择时,要切合自身实际来定
|
前端开发 C++
前端知识学习案例1vs code-安装vs code
前端知识学习案例1vs code-安装vs code
85 0
前端知识学习案例1vs code-安装vs code
|
JavaScript 前端开发 程序员
60 个神级 VS Code 插件!(1)
60 个神级 VS Code 插件!(1)
290 0
60 个神级 VS Code 插件!(1)
|
JSON JavaScript 前端开发
60 个神级 VS Code 插件!(3)
60 个神级 VS Code 插件!(3)
556 0
60 个神级 VS Code 插件!(3)
|
JSON JavaScript 前端开发
一起来写 VS Code 插件:为你的团队提供常用代码片段
VS Code 是前端开发者最佳的开发工具,你在开发中是否疲倦了从一个文件拷贝来新建一个文件呢?那么如何发布一个 VS Code 插件?
300 0

热门文章

最新文章