코드 가독성에 대해 – 2. 명명과 주석

LINE의 Android 클라이언트 팀에서 코드 가독성을 높이기 위한 두 번째 글입니다. 이번 글에서는 프로그램 내 자연어 작성에 초점을 맞춰 '명명(Naming)'과 '주석(Comments)'에 대해 설명합니다.

명명에서는 대상의 '내용'과 '하는 일'을 명확히 나타내는 것이 중요하며, 이는 대상의 책임을 명확히 하고 중복 조작이나 복잡한 의존 관계를 방지하는 데 도움이 됩니다. 문법과 단어 선택 또한 가독성에 영향을 미치는 요소로 다룹니다.

주석은 코드의 의도를 명확히 전달하고 유지보수를 용이하게 하는 역할을 하지만, 코드 자체로 의미가 명확하다면 불필요한 주석은 피해야 함을 강조합니다. 전반적으로 명확하고 간결한 명명과 적절한 주석 사용이 코드의 이해도를 높이고 협업을 원활하게 하는 핵심임을 시사합니다.