[TIL] 주석 처리 (가독성)

지금껏 주석처리는 그저 설명만 쓰는 형식을 취함

// 주석 내용
// 주석 내용

그런데 어느 코드를 보던 중 참고할만한 사항이라 생각되는 주석처리 방식이 보여서 정리하고, 따라해보려 함

// (A) A에 대한 주석
    
    // (B) A의 내부 B에 대한 주석
    	// (B1) B의 하부 내용 주석 1
        // (B2) B의 하부 내용 주석 2
        
        // (C) C 에 대한 주석
            // (C1) C의 내부 내용 주석 1
            // (C2) C의 내부 내용 주석 2
            // (C3) C의 내부 내용 주석 3

 

• 위와 같이 같은 역할을 하는 파트를 같은 문자(알파벳)로 묶어 주석 정리
• 그 안에 돌아가는 내용에 대한 주석은 숫자(1, 2, 3, · · ·)를 붙여 처리
• 이렇게 함으로써 가독성이 올라가고, 전체적인 윤곽과 흐름 파악에 도움이 됨

---

참고 사이트

• PHP, JS & Node, HTML & CSS, Python, SQL & Others, AI 등의 튜토리얼(Tutorials)
• PHP, HTML & JS의 오픈소스 프로젝트(Open Source)를 제공하는 사이트

https://code-boxx.com/

Code Boxx – Inspire your inner programmer