형식을 맞추는 목적

프로그래머라면 형식을 깔끔하게 맞춰 코드를 짜야 한다

돌아가는 코드가 개발자의 의무라고 생각하겠지만, 오늘 구현한 기능이 다음 버전에서 바뀔 확률은 아주 높다. 그런데 오늘 구현한 코드의 가독성은 앞으로 바뀔 코드의 품질에 지대한 영향을 미친다. 오랜 시간이 지나 원래 코드의 흔적을 더 이상 찾아보기 어려울 정도로 코드가 바뀌어도 맨 처음 잡아놓은 구현 스타일과 가독성 수준은 유지보수 용이성과 확장성에 계속 영향을 미친다. 원래 코드는 사라져도 개발자의 스타일과 규율은 사라지지 않는다.

적절한 행 길이를 유지하라

신문 기사처럼 작성하라

신문기사는 최상단에 기사를 몇 마디로 요약하는 표제가 나온다. 첫 문단은 전체 기사 내용을 요약한다. 세세한 사실은 숨기고 커다란 그림을 보여준다. 아래로 내려가면 세부사항이 나온다. 코드도 이렇게 써라.

이름은 간단하면서도 설명이 가능하게. 이름만 보고도 올바른 모듈을 살펴보고 있는지 아닌지를 판단할 정도로 신경 써서 짓는다. 소스 파일 첫 부분은 고차원 개념과 알고리즘을 설명한다. 아래로 내려갈수록 의도를 세세하게 묘사한다. 마지막에는 가장 저차원 함수와 세부 내역이 나온다.

개념은 빈 행으로 분리하라

생각 사이는 빈 행을 넣어 분리해야 읽기 쉽다
-> 당연

세로 밀집도 & 수직거리

• 서로 밀접한 코드 행은 세로로 가까이 놓여야 한다. 따라서 서로 밀접한 개념은 한 파일에 속해야 한다
  -> protected 변수를 피해야 하는 이유이다.

Dart에는 protected 변수와 같은 개념이 없다. underscore를 이용한 private 변수 선언만 가능하다

• 변수선언 : 변수는 사용하는 위치에 최대한 가까이 선언한다
  반면, 인스턴스 변수는 클래스 맨 처음에 선언한다.

• 종속함수 : 가능한 호출하는 함수를 호출되는 함수보다 먼저 배치한다. 그러면 프로그램이 자연스럽게 읽힌다.
  -> 가끔 선언되지 않은 함수를 호출했다는 오류를 보게되는데.. 어떤 경우였는지 기억이 안나네

가로 형식 맞추기

가로 행 길이나 들여쓰기(Indentation)는 요즘은 별로 안중요하다고 생각한다. lint가 자동으로 맞춰주기 때문이다. 여기는 가볍게 읽고 패스

밥아저씨의 형식 규칙 예제

CodeAnalyzer.java 를 Dart로 수정해보았다.
File처리를 해야하는 analyzeFile() 함수는 async함수로 수정하고 내용도 좀 바꿨다

import 'dart:io';

class CodeAnalyzer {
  int _lineCount = 0;
  int _maxLineWidth = 0;
  int _widestLineNumber = 0;
  LineWidthHistogram _lineWidthHistogram = LineWidthHistogram();
  int _totalChars = 0;

  CodeAnalyzer();

  static List<File> findDartFiles(Directory parentDirectory) {
    List<File> files = [];
    _findDartFiles(parentDirectory, files);
    return files;
  }

  static void _findDartFiles(Directory parentDirectory, List<File> files) {
    for (var entity in parentDirectory.listSync()) {
      if (entity is File && entity.path.endsWith('.dart')) {
        files.add(entity);
      } else if (entity is Directory) {
        _findDartFiles(entity, files);
      }
    }
  }

  Future<void> analyzeFile(File dartFile) async {
    var lines = await dartFile.readAsLines();
    for (var line in lines) {
      measureLine(line);
    }
  }

  void measureLine(String line) {
    _lineCount++;
    int lineSize = line.length;
    _totalChars += lineSize;
    _lineWidthHistogram.addLine(lineSize, _lineCount);
    recordWidestLine(lineSize);
  }

  void recordWidestLine(int lineSize) {
    if (lineSize > _maxLineWidth) {
      _maxLineWidth = lineSize;
      _widestLineNumber = _lineCount;
    }
  }

  int getLineCount() => _lineCount;
  int getMaxLineWidth() => _maxLineWidth;
  int getWidestLineNumber() => _widestLineNumber;
  LineWidthHistogram getLineWidthHistogram() => _lineWidthHistogram;

  double getMeanLineWidth() => _totalChars / _lineCount;

  int getMedianLineWidth() {
    var sortedWidths = getSortedWidths();
    int cumulativeLineCount = 0;
    for (var width in sortedWidths) {
      cumulativeLineCount += lineCountForWidth(width);
      if (cumulativeLineCount > _lineCount / 2) return width;
    }
    throw Exception("Cannot get here");
  }

  int lineCountForWidth(int width) =>
      _lineWidthHistogram.getLinesForWidth(width).length;

  List<int> getSortedWidths() {
    var widths = _lineWidthHistogram.getWidths();
    var sortedWidths = widths.toList();
    sortedWidths.sort();
    return sortedWidths;
  }
}

class LineWidthHistogram {
  final Map<int, List<int>> _widths = {};

  void addLine(int lineSize, int lineCount) {
    _widths.putIfAbsent(lineSize, () => []).add(lineCount);
  }

  List<int> getLinesForWidth(int width) => _widths[width] ?? [];
  Set<int> getWidths() => _widths.keys.toSet();
}


/// 아래는 CodeAnalyzer 테스트를 위한 main함수를 추가한 것이다
Future<void> main() async {
  var directory = Directory.current;

  var dartFiles = CodeAnalyzer.findDartFiles(directory);
  print('${dartFiles.length} Dart files found.');

  var analyzer = CodeAnalyzer();
  for (var file in dartFiles) {
    await analyzer.analyzeFile(file);
  }

  print('Total Lines: ${analyzer.getLineCount()}');
  print('Max Line Width: ${analyzer.getMaxLineWidth()}');
  print('Widest Line Number: ${analyzer.getWidestLineNumber()}');
  print('Mean Line Width: ${analyzer.getMeanLineWidth()}');
  try {
    print('Median Line Width: ${analyzer.getMedianLineWidth()}');
  } catch (e) {
    print(e);
  }
}