주석

soomin·2021년 8월 13일
0

Java-Basic

목록 보기
3/13

0. 주석


  • 작성하는 프로그램이 커지면 커질 수록, 프로그램을 이해하고 변경하는 일이 점점 더 어려워진다.
  • 남이 작성한 코드를 이해하는 일은 정말 쉬운 일이 아니다.

주석은 프로그램을 이해하고 작성자, 작성일자, 변경사항, 버전 등의 정보를 제공할 목적으로 사용한다.



1. 종류


  1. // 단일 행 주석
  2. /* ~ */ 다중 행 주석
  3. /** ~ */ javadoc 주석
// 단일 행 주석
/*
 다중 행 주석
*/

/**
	 * @변경일 : 2021. 08. 13.
	 * @변경자 : s.m.jung
	 * @변경이력 : 클래스를 필드 정보를 가져와 ThreadLocal#remove() 함수를 호출시키도록 변경하였습니다.
	 * @Method 설명 : 클래스에 있는 모든 ThreadLocal 필드를 순회하면서 저장 값을 지워줍니다.
	 * @return void
	 */
	public static void resetAll()  {

		Field[] fields = Pagination.class.getFields();
		for (Field field : fields) {
			try{
				((ThreadLocal)field.get(null)).remove();
			}catch (IllegalAccessException e) {
				e.printStackTrace();
			}
		}
	}

주석은 컴파일러가 무시하기 때문에 성능에 영향을 끼치지 않는다.

profile
블로그 유목민

0개의 댓글