이클립스 자동완성 기능으로 독시젠 주석 쉽게 입력하는 방법

2019. 4. 10. 04:30 컴퓨터/유틸리티

이클립스 자동완성 기능으로 독시젠 주석 쉽게 입력하는 방법

프로그램을 작성할 때 문서 생성을 위해 독시젠 주석을 꼭 입력합니다. 개발이 완료되면 소스 코드에 대한 설명 문서를 요구 받을 때가 있는데, 그때 문서를 만들기 보다는 평소에 입력해 둔 주석으로 자동으로 문서를 생성하면 수고를 크게 덜 수 있습니다. 개발자 대부분이 문서 만드는 것을 참 싫어할 것입니다. 차라리 코드 짜는 것이 편하지, 내가 만든 코드라도 문서로 만들려면 짜증부터 납니다. 내용이 적은 것도 아니고. 그래서 독시젠이 생겼겠습니다만.

독시젠 주석은 항목이 여러 개라서 직접 입력하기에는 내용이 많습니다. 조금 편하게 입력하기 위해서 클립보드 확장 프로그램에 주석문을 템플릿 메뉴에 등록해서 붙여넣기 할 수 있습니다. 그러나 이클립스를 사용한다면 클립보드 확장 프로그램보다는 이클립스의 템플릿을 이용하는 것이 더 편합니다. 특히, 날짜와 시간을 현재 시간으로 입력해 주는 치환자가 있어서 더욱 유용합니다.

사용하는 방법은 간단합니다. 이클립스에서 코딩할 때 키워드를 입력하고 Ctrl-Space 키를 누르면 자동으로 문장을 완성 시켜주는 기능을 이용하는 것입니다. if 입력하고 Ctrl-Space 키를 누르면 if 절이 완성되는 것처럼 주석문도 자동으로 입력하게 하는 것이죠.

이클립스 자동완성 독시젠 주석

▲ 메인메뉴>>윈도우>>설정을 실행한 후 언어별로 Editor 안에 있는 Templates를 선택합니다. 이클립스에는 언어별로 매우 다양한 템플릿이 준비되어 있습니다. 템플릿을 잘 활용하면 빠르게 작업할 수 있습니다. 새로운 템플릿을 추가하기 위해 "New..." 버튼을 클릭합니다.

이클립스 자동완성 독시젠 주석

▲ 파일마다 상단에 파일 전체에 대한 설명을 꼭 입력하는데, 키워드를 title로 하고 그에 맞는 주석문을 입력했습니다. 주석문에 파일 이름이나 날짜·시간을 치환해 주는 변수를 같이 활용하면 더욱 좋습니다. 변수는 "Insert Variable..." 버튼으로 쉽게 입력할 수 있습니다.

이클립스 템플릿 사용 방법

이클립스 자동완성 독시젠 주석

▲ 추가한 템플릿을 적용합니다. 다른 프로젝트에서 사용할 수 있도록 Export로 파일로 저장해 두면 유용합니다.

이클립스 자동완성 독시젠 주석

▲ 에디터에서 title을 입력하고 Ctrl-Shift 키를 누르면 등록된 템플릿이 자동으로 입력됩니다. 파일 이름과 날짜·시간을 자동으로 입력해 주니 참 편하죠. 이와 같은 방법으로 스트럭쳐나 함수별로 템플릿을 추가합니다. 파일 주석문의 경우 소스 파일이 생성할 때 자동으로 삽입하는 방법을 이용하면 더욱 편합니다.

문제라면 이렇게 템플릿을 이용하면 이클립스말고 다른 에디터에서 작업하려고하면 많이 답답합니다. 이클립스 의존률이 높아지기는 하지만, 이클립스가 무겁기는 해도 윈도우와 리눅스 모두에서 사용할 수 있어서 다행입니다.

이 댓글을 비밀 댓글로