How junhopark93/google-java-styleguide works
이 프로젝트는 Google Java Style Guide의 한국어 번역 문서로, 시스템 설계 다이어그램이 필요하지 않은 문서화 프로젝트입니다. 하지만, 이 문서의 내용을 시각화하여 설명하는 참조 다이어그램을 만들 수 있습니다. 다음과 같이 설명하겠습니다:
문서 구조 다이어그램
주요 섹션들을 계층적으로 표현하는 다이어그램을 만듭니다:
[Google Java Style Guide]
• 1. 개요
• 1.1 용어 노트
• 1.2 가이드 노트
• 2. 소스파일 기본
• 2.1 파일명
• 2.2 파일 인코딩
• 2.3 특수 문자들
...
규칙 관계도
주요 규칙들 간의 관계를 보여주는 다이어그램:
[코드 스타일 규칙]
• ┌─────────────────┐
• 포매팅 │
• ┬────────┘
• ┌─────────┴─────────┐
[구조적 규칙] [네이밍 규칙]
• v v
들여쓰기 클래스명
줄 길이 메서드명
블록 구조 변수명
시각적 요소
• 색상 코드:
• 필수 규칙: 빨간색
• 권장 규칙: 노란색
• 선택적 규칙: 초록색
• 화살표 표시:
• 실선 화살표: 직접적 관계
• 점선 화살표: 간접적 관계
[범례]
━━━ 필수 규칙
• 권장 사항
••••• 선택적 규칙
🔴 중요 규칙
🟡 주의 사항
🟢 팁
다이어그램 작성 지침
• 최상위 레벨에서는 주요 섹션들을 보여줌
• 각 섹션은 확장 가능한 하위 노드로 표현
• 관련 규칙들은 그룹화하여 표시
• 예외사항은 별도로 하이라이트
• 상호 참조되는 규칙들은 연결선으로 표시
중요 고려사항
• 문서의 계층 구조를 명확히 표현
• 규칙들 간의 관계를 시각적으로 표현
• 예외사항과 특별 케이스를 강조
• 쉽게 참조할 수 있는 형태로 구성
이러한 다이어그램은 Google Java Style Guide의 내용을 시각적으로 이해하고 참조하는데 도움이 될 것입니다.