[리뷰하기 좋은 코드 작성] 주석 작성하기
주석의 종류1. 문서화 주석 (Documentation Comments)형식: /** ... */ 또는 언어별 문서화 도구 형식목적: API 문서 자동 생성, 공개 인터페이스 설명대상: 클래스, 함수, 메서드의 공개 인터페이스내용: 기능 설명, 매개변수, 반환값, 예외, 사용 예시/** * 사용자 정보를 데이터베이스에서 조회합니다. * * @param userId 조회할 사용자의 고유 ID (양수여야 함) * @return 사용자 정보 객체, 없으면 null * @throws IllegalArgumentException userId가 0 이하일 때 */fun getUserById(userId: Int): User? 2. 비형식 주석 (Informal Comments)형식: // (한 줄) 또는 /* ....