반응형

javadoc 2

[JAVA] Javadoc 완벽 가이드

1. Javadoc이란?Javadoc은 Java에서 제공하는 문서화 도구로, Java 소스 코드에서 특정 형식의 주석을 사용하여 자동으로 API 문서를 생성할 수 있도록 돕는다.이를 통해 코드의 설명을 문서로 만들고, 개발자들이 쉽게 참조할 수 있게 한다. ✅ Javadoc의 주요 특징 • 자동 문서 생성: /** */ 주석을 사용하여 작성한 내용을 HTML 문서로 변환 • 클래스, 인터페이스, 메서드, 필드 설명 포함 • HTML 링크와 연계 가능하여 다른 클래스 및 메서드 간 참조 제공 • JDK 기본 라이브러리(예: String, ArrayList 등)도 Javadoc을 사용하여 문서화됨   2. Javadoc 주석 문법Javadoc 주석은 /** */ 형태로 사용되며, 일반적인 /* */ 주석과는..

JAVA 2025.02.03

[JAVA] 자바 코딩 규칙(Java Coding Conventions)

자바에서는 가독성과 유지보수를 위해 일정한 코딩 스타일을 따르는 것이 중요하다. 다음은 Java 코딩 규칙(Java Coding Conventions)에 대한 주요 사항이다.   1. 패키지, 클래스, 변수, 메서드 명명 규칙자바에서는 식별자(변수, 메서드, 클래스 이름 등)를 정할 때 일관된 네이밍 규칙을 따른다. (1) 패키지명 (Package Name) • 소문자 사용 • com.회사명.프로젝트명 형태로 작성 • 단어가 여러 개일 경우 .으로 구분 • 예시:package com.example.myapp; (2) 클래스명 (Class Name) • 첫 글자는 대문자(CamelCase) • 각 단어의 첫 글자를 대문자로 작성 (PascalCase) • 예시:public class MyClass { }p..

JAVA 2025.02.03
반응형