[Java, Spring] 코드 문서화를 위한 주석 규칙 알아보기
프로그래밍/Java2024. 10. 31. 12:34[Java, Spring] 코드 문서화를 위한 주석 규칙 알아보기

다수와 같이 프로젝트를 할 때 메모를 남기는 것은 필수라고 생각합니다. Swagger, Javadoc 등으로 메모한 내용들을 문서화할 수 있고, 평소에는 Swagger만 사용하다 프로젝트 내부에 조금 더 자세히 기록을 남기고 싶어 오늘은 Javadoc 코드 문서화하는 규칙을 알아보려고합니다 ! JavaDoc Tag와 작성 규칙@version구현체(클래스, 메소드, 변수 등)의 버전@author작성자@deparecated해당 구현체가 곧 삭제, 업데이트 중단을 의미@since해당 구현체가 추가된 버전@see외부 링크나 텍스트, 다른 필드나 메소드를 링크할 때 사용@linksee와 동일한 기능, 참조에 대한 링크 제공@exception발생할 수 있는 Exception을 정의@throws코드에서 throw할 ..

image