📌개요
개발 문서를 작성하다 보면 계층 구조를 표현하거나 흐름을 명확하게 정리하거나 문서 포맷을 시각적으로 구조화해야 할 때가 많다.
문서 작성 시 자주 사용하는 특수 문자 모음을 종류별로 간략히 정리한다.
📌내용
분류 개요
| 분류 | 목적 | 활용 예 |
|---|
| 계층 구조 표현 | 디렉토리/구조 표시 | 트리 구조, 파일 구조 |
| 흐름/논리 표현 | 동작 흐름 연결 | 알고리즘, 프로세스 |
| 강조 및 주석 | 중요 포인트 전달 | 설계 문서 |
| 상태/태스크 표시 | 작업 상태 관리 | TODO 문서 관리 |
| 코드/개발 표현 | 문법 표기 | 코드 스타일 |
| 수학/논리 | 조건/수식 표현 | 알고리즘 명세 |
1. 계층 구조(Tree) 표현
1
2
3
4
5
6
| 프로젝트 구조 예시
├─ src
│ ├─ main
│ │ └─ java
│ └─ test
└─ README.md
|
| 기호 | 용도 |
|---|
├─ | 중간 노드 |
└─ | 마지막 노드 |
│ | 계층 연결 |
/ | 경로 구조 표현 |
> | 종속 또는 흐름 표시 |
2. 흐름/관계 표현
| 기호 | 의미 | 예시 |
|---|
→ | 단순 흐름 | 로그인 → 인증 → 응답 |
⇒ | 결과 | Cache Miss ⇒ DB 조회 |
-> | 단방향 관계 | A -> B |
<-> | 양방향 | Client <-> Server |
==> | 강한 흐름 | 요청 ==> 처리 |
~~> | 비동기 흐름 | 요청 ~~> 큐 |
3. 강조 및 설명
| 기호 | 의미 | 사용 예 |
|---|
※ | 중요 포인트 | ※ 환경 변수 필수 |
! | 주의 | ! 삭제 주의 |
⚠ | 경고 | ⚠ 민감 정보 노출 위험 |
💡 | 힌트 | 💡 캐시 적용 가능 |
★ | 핵심 | ★ 주요 설계 포인트 |
4. 상태/태스크 관리
5. 코드/문법 표현용 기호
| 기호 | 설명 |
|---|
{ } | 코드 블록/JSON |
[ ] | 배열/옵션 |
( ) | 파라미터 |
< > | 제네릭/HTML 태그 |
:: | 네임스페이스/스코프 |
=> | 람다/매핑 표현 |
6. 수학/논리 표현
| 기호 | 설명 |
|---|
= | 같다 |
≠ | 같지 않다 |
∧ | AND |
∨ | OR |
≥ | 이상 |
∴ | 따라서 |
∵ | 왜냐하면 |
