자바 Documentation, 주석

자바 API 문서

API(Application Programming Interface ) : API는 제공되는 기능을 사용할 수 있도록  제공되는 인터페이스이다

 

주석

개발자가 만든 소스 코드 중에 컴파일시 컴파일러에 의해 무시되는 부분을 의미

소스 코드 컴파일시 컴파일러는 소스 코드에 있는 주석 부분은 컴파일하지 않는다

소스 코드에 대한 설명 부분이 필요한 경우에 사용

소스 코드중  일부분을 수행되지 않도록 해줄 때 사용

 

주석의 활용

수업 중 메모가 필요한 부분이 있으면 소스 코드에 주석으로 메모

프로그램 작성시 프로그램 작동 순서를 먼저 주석으로 작성

소스 코드 분석시 소스 코드를 통해 이해한 내용을 주석으로 정리

개발 한 이후 나중에 소스 코드에 대한 내용을 쉽게 알아볼 수 있도록 소스 코드 작성 시 주석 작성을 소홀히 해선 안됨

 

주석의 종류

//  한 줄짜리 주석

 

/*  여러 줄을 묶어 줄때 사용

*/

 

/**  class 파일을 자바 문서로 만들어줄 때 사용하는 주석

*/

 

 

EClipse SRC New Class에 Public static void main 메인이 있는 파일을 만들 때 사용

 

Must declare a named package because this compliation unit is associated to the named module 오류 발생 시 자바 프로젝트 생성 할 때 버전을 1.8로 바꾸면 오류 해결됨

 

주석 작성 소홀히 하지 않기