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



相关文章
【EDA】 Verdi 使用笔记
【EDA】 Verdi 使用笔记
3774 0
【EDA】 Verdi 使用笔记
|
API
xxl-job restful api
xxl-job restful api
468 0
|
2月前
|
人工智能
Claude code AI 技能神器:Anthropic Skills!
Anthropic推出Claude AI技能神器Skills,将复杂任务打包成即插即用的“外挂”,让AI秒懂流程,告别重复提示。支持团队共享,提升效率数倍,三步搞定专业报告,堪称AI办公革命!
867 4
|
安全 JavaScript 前端开发
API 通用规范
API 通用规范
699 0
|
18天前
|
Java 调度 数据库
搭建XXL-JOB
XXL-JOB由调度中心和执行器两部分组成。调度中心负责任务调度与管理,支持动态配置、监控告警;执行器部署在微服务中,接收调度请求并执行任务。通过SpringBoot集成xxl-job-core,配置注册地址后可自动注册到调度中心,实现分布式任务调度。
|
9月前
|
Java 数据库 微服务
微服务——SpringBoot使用归纳——Spring Boot中的项目属性配置——指定项目配置文件
在实际项目中,开发环境和生产环境的配置往往不同。为简化配置切换,可通过创建 `application-dev.yml` 和 `application-pro.yml` 分别管理开发与生产环境配置,如设置不同端口(8001/8002)。在 `application.yml` 中使用 `spring.profiles.active` 指定加载的配置文件,实现环境快速切换。本节还介绍了通过配置类读取参数的方法,适用于微服务场景,提升代码可维护性。课程源码可从 [Gitee](https://gitee.com/eson15/springboot_study) 下载。
398 0
|
SQL Java Maven
idea如何建立一个springboot项目
idea如何建立一个springboot项目
326 0
|
开发工具 git
git分支管理master/hotfix/develop/feature/release
采用合理的Git分支管理模型可以显著提升团队协作效率和代码管理的质量。本文介绍的 `master`、`develop`、`feature`、`release`和 `hotfix`分支模型是一个行之有效的方法,适用于大多数软件开发项目。通过清晰地划分各个分支的职责,团队成员可以更专注于各自的开发任务,同时确保代码库的稳定性和可维护性。
1432 2
|
Kubernetes Cloud Native 微服务
探索云原生技术:Kubernetes在微服务架构中的应用Python编程之旅:从基础到进阶
【7月更文挑战第31天】随着云计算技术的迅猛发展,云原生概念应运而生,它代表了一种构建和运行应用程序的全新方式。本文将通过实际代码示例,深入探讨Kubernetes这一云原生关键技术如何在微服务架构中发挥其强大的作用。我们将从容器化开始,逐步过渡到Kubernetes集群的搭建与管理,最后展示如何部署和管理一个微服务应用。
209 2
|
JSON 缓存 Java
Spring Boot集成 Swagger2 展现在线接口文档
本节课详细分析了 Swagger 的优点,以及 Spring Boot 如何集成 Swagger2,包括配置,相关注解的讲解,涉及到了实体类和接口类,以及如何使用。最后通过页面测试,体验了 Swagger 的强大之处,基本上是每个项目组中必备的工具之一,所以要掌握该工具的使用,也不难。

热门文章

最新文章