24.10.28

 

문서 주석

기본적으로 주석은 코드안에 들어있지만 컴파일할때는 없는 것처럼 인식되어, 개발자들이 코드를 분석할때 필요한 정보를 기록해놓을때 사용한다. 그래야 코드를 빠르게 이해하고 구조를 파악하는데 용이하기 때문이다. 이런 일반적인 주석 말고도 하나가 더있다.

 

바로 문서 주석이라는것이다. 주석처리가 되면 아예 인식이 안되는 다른것들과는 다르게, 문서주석은

• /// 또는 /**

로 사용한다. 

 

/**
 * 두 수의 곱을 반환하는 함수입니다.
 *
 * 이 함수는 [a]와 [b]를 곱하여 그 결과를 반환합니다.
 * 예를 들어, multiply(2, 3)은 6을 반환합니다.
 */
int multiply(int a, int b) {
  return a * b;
}

위와같은 방식으로 사용한다. 일반주석과 비슷하지만, []를 이용하여 []안에 들어간 요소를 이용하여 문서화를 할때 이용한다.

 

이때 문서화란 []를 이용한 요소를 이용하여, 자동으로 문서를 작성하는 방식을 말한다.

문서화는 문서화는 코드의 품질을 높이고, 유지보수, 협업, 이해도를 향상시킬 수 있다.

 

 

공부할때 LLM사용

LLM(large language Model)의 대표적인것은 ChatGPT이다. 요즘은 AI가 많이 발달해서 일반인들도 많이 사용하는 추세이다. 그래서 AI로 공부할때 사용할 수도 있지만 아직은 완벽하지 않기 때문에 좋지않다. 그리고 처음 공부를 시작하는 단계에서 사용하게 되면 스스로 개발을 할 수 없게 되고, AI에만 의존하게 된다. AI를 제대로 사용하기 위해서는 베이스 지식이 잘 다져서 있어야 필요한 정보를 찾을 수있는것이다. 그렇기에 공부를 시작할때는 스스로 생각하고, 검색해보고 공부해야한다. AI에 의존하면 AI를 뛰어넘는 개발자가 될 수 없다.