STS(Spring Tool Suite) 자동 주석 템플릿 설정 방법

STS에서의 자동 주석 설정 및 주석 작성 가이드

자동 주석 설정 방법

JSP 파일 설정

1. Window > Preferences로 이동합니다.
2. Web > JSP Files > Editor > Templates로 이동합니다.
3. Templates에서 New JSP File (html 5)를 선택하고 Edit 버튼을 클릭합니다.

jsp주석

JAVA 파일 설정

1. Java > Code Style > Code Templates로 이동합니다.
2. Comments에서 Types (클래스 주석)와 Methods (메서드 주석)을 선택하여 편집합니다.

java주석

템플릿 주석 단축키

• Shift + Alt + j

사용자 이름 매핑 추가

• sts.ini 파일에 -Duser.name=영문명을 추가하여 코드 내에서 사용자의 이름을 자동으로 채워 넣습니다.

유저이름설정

사용 가능한 식별자

• ${date}: 현재 날짜
• ${time}: 현재 시간
• ${user}: 사용자 이름
• ${year}: 현재 연도
• ${package_name}: 클래스의 패키지 이름
• ${type_name}: 클래스나 인터페이스의 이름
• ${method}: 메서드 이름
• ${todo}: 작업해야 할 사항

예시

/**
 * Class Name: ${type_name}
 * Date: ${date}
 * Author: ${user}
 *
 * Class Description:
 * TODO: Add class description here.
 */
public class ${type_name} {
    // implementation
}

주석의 중요성

주석은 코드의 이해도를 높이고, 유지보수를 쉽게 하며, 팀원 간의 원활한 커뮤니케이션을 지원합니다. 코드의 목적, 복잡한 로직의 설명, 변경 이유 등을 명확하게 전달하여 코드를 처음 보는 사람도 쉽게 이해할 수 있게 돕습니다.

주석 작성 요령

• 목적과 설명: 코드가 수행하는 작업과 그 이유를 명확히 기술합니다.
• 간결성: 주석은 간결하고 명확해야 합니다. 불필요한 정보는 제외하세요.
• 유지보수: 코드 변경 시 주석도 함께 업데이트하여 정보의 일관성을 유지하세요.
• 표준화: 팀 내 주석 형식과 사용법에 대한 표준을 마련하여 일관성을 유지하세요.