무엇

doxygen는 c, c++,java,python 등 원본 코드를 자동으로 문서화하는 도구입니다.원본 코드에doxygen을 기록하는 특수 명령을 주석으로 삼아 원본 코드를 >와pdf 형식으로 문서화python의 예합니다.GUI에서는 사용할 수 있지만 이번에는 배우기 위해 CLI부터 사용하려고 합니다.

무엇

docker는 각 어플리케이션의 Linux 가상 환경을 손쉽게 구축할 수 있는 도구입니다.리눅스 전용 도구였는데 최근에는 Mac와 Windows의 로컬 애플리케이션 베타 버전이 출시된 것 같다.
구축된 환경을 이미지로 저장할 수 있고 다른 사용자도 같은 환경에서 응용 프로그램을 사용할 수 있다.
docker hub에서 제공한 다른 사용자가 미리 구축한 이미지를 사용하여 목적 응용 환경을 쉽게 이용할 수 있다.
한마디로 리눅스 앱을 사용하고 싶지만 설정 등 여러 가지 번거로움 때문에 그렇게 다른 사람이 해준 환경에 가상 환경을 가져온다.

하고 싶은 일

자신이 속한 연구실에서 Doxygen을 쉽게 사용할 수 있도록 Docker에서 Doxygen을 이동하여 원본 코드를 문서화합니다.평소에 지령선을 잘 건드리지 않는 사람이 해설을 한다고 가정해 보세요.

구상적 환경

호스트 환경은 Windows로 가정됩니다.또한, docker를 사용하기 위해서는 PC의 대응 가상화 지원 기능(AMD-V/Intel VT)이 필요하다.낡은 PC가 대응하지 않았다면

작업 확인 환경

OS: Windows10 home
PC: ThinkPad E540(Intel VT 지원)

docker 설치

Windows에서 docker를 사용하려면 두 가지 옵션이 있습니다.

docker for 윈도우즈(beta 버전)

docker toolbox

docker for 윈도우즈는 2016년 6월까지 베타 버전으로 사용하기 위해 사전에 로그인하여 설치에 필요한 영패를 획득해야 한다.또한 docker for 윈도우즈를 사용하기 위해서는 윈도에서 제공하는 가상 기기 실행 환경인 Hyper-V(Windows 8/8.1/10/Pro/Eduction/Enterprise에서 사용할 수 있음)가 필요하다.
docker for 윈도우즈는 Windows 로컬 응용 프로그램으로Virutual Box 등 가상 기기를 가져올 필요가 없습니다.
자신이 사용하는 OS(Windows10 Home)가 Hyper-V와 대응하지 않기 때문에 이번에는 docker toolbox를 활용한다.원래 docker는 Linux 전용 도구로 Windows에서 사용하기 위해 가상 컴퓨터를 가져와야 합니다.아무래도 귀찮은 것 같지만 docker toolbox를 이용하면 가상 머신(Virtual Box)을 포함하는 것을 자동으로 설치합니다.

docker toolbox 설치

Windows용 docker toolbox여기.를 다운로드합니다.

설치 전

docker와 같은 가상화 기술을 활용하려면 가상화 지원 기능(AMD-V 또는 Intel VT)을 활성화해야 합니다.BIOS에서 이 기능의 설정을 수행합니다.
BIOS에 접속하는 방법은 사용하는 PC에 따라 다르지만, PC를 시작할 때 표시되는 기능키와 Enter 키를 누르면 BIOS 화면을 열 수 있을 것으로 보인다.
Intel VT는 자신이 사용한 ThinkPad의 경우 다음과 같이 유효합니다.
1. PC를 시작하자마자 Enter 키를 눌러 Startup Interrupt Menu를 엽니다.
2. F1 키를 눌러 BIOS Setup Utility 열기
3. 화살표 키를 사용하여 Security 태그로 이동하고 Enter 키를 사용하여 Virtualization 항목을 선택합니다.
4. Enter 키를 사용하여 Intel(R) Virtualization Technology를 선택하여 Ennabled로 변경
5. F10 키를 사용하여 설정을 저장하고 BIOS 화면을 종료합니다.

설치 프로그램

다운로드한 docker toolbox 설치 프로그램을 실행하고 설치 프로그램의 지시에 따라 설치를 완료합니다.
이번에 설치한 모든 구성 요소는 다음과 같다.

다음 Qita 기사에 따르면 VirtualBox는 NDISS 드라이버로 설치하는 것이 좋습니다.

Windows 10 시스템에 Docker Toolbox를 추가하여 개인 개발 환경 조성

Docker Quickstart Terminal 오류 발생 정보

docker 작업 확인

docker toolbox 설치가 완료되면 Docker Quickstart Terminal을 실행합니다.Docker Quickstart Terminal은 Giit for bash용 터미널을 시작한 뒤 가상 머신과 환경 변수를 자동으로 설정하는 등 docker의 설정을 편안하게 활용하기 위한 것이다.
또한 Docker Quickstart Terminal을 처음 실행할 때 VirtualBox의 docker는 가상 머신으로default의 이름을 만들어 낸다.

위의 그림처럼 docker logo를 표시하면 설치가 순조롭게 진행될 것입니다.

이용 방법

먼저 docker hub에서doxygen 이미지를 다운로드합니다.

$ docker pull hytssk/doxygen

일정 시간 두었다가 다운로드가 완료되면 Doxygen을 사용할 수 있습니다.

Doxyfile 생성

Doxygen의 설정 파일로 Doxyfile을 생성합니다.
문서의 소스 파일을 디렉토리로 이동하여 Doxy file을 생성합니다.
예를 들어, C:\Users\hoge\Docoments\My Project 디렉토리로 이동하는 경우

$ cd /c/Users/hoge/Documents/My\ Project

구문을 사용합니다.이동한 후 다음 명령을 사용하여 Doxyfile을 생성할 수 있습니다.

$ docker run --rm -v "${PWD}":/src hytssk/doxygen -g

Doxyfile을 생성한 후 원하는 텍스트 편집기에서 Doxyfile을 편집합니다.
참고로 Windows 탐색기에서 현재 디렉토리를 열려면 다음과 같이 하십시오.

$ start .

다음 페이지에서는 Doxyfile 설정 항목을 쉽게 이해할 수 있습니다.
Doxyfile(기본) - Algo13 2016.04.1 문서
더 자세히 알고 싶으면 공식. 설명을 읽어 보세요.
doxygen의 동작을 확인하려면 다음 설정 항목을 변경할 수 있습니다.

EXTRACT_ALL : NO ⇒ YES

RECURSIVE : NO ⇒ YES

문서 작성

Doxyfile 편집이 끝나면 설정된 내용에 따라 소스 코드를 문서화합니다.
문서화하려면 Doxygen에 대한 설명을 소스 코드에 추가해야 합니다.
주석의 기술 방법의 상세한 상황은 공식.를 참조하시오.
다음은python 코드의 예입니다.
hoge.py

## テスト関数
#  
#  ここに関数の詳細な説明を記述します。
#  @param hoge: 引数の説明を記述します。
#  @return 返り値の説明を記述します。
def test(hoge):
   ret = hoge * 3
   return ret

doxygen의 주석을 설명할 때 다음 명령을 실행하여 문서를 생성합니다.

$ docker run --rm -v "${PWD}":/src hytssk/doxygen Doxyfile

기본적으로} 파일과 pdf 파일을 문서로 생성합니다.
이번에는 브라우저로 현재 디렉터리에 생성된 html 파일을 열어 보겠습니다.

$ start html/index.html

프로젝트 페이지를 잘 표시하면 성공합니다.

별칭 설정

문서를 생성할 때마다 긴 명령을 입력하는 것은 매우 번거롭기 때문에 다음 명령을 사용하여 별명을 만듭니다.

$ echo "alias doxygen='docker run --rm -v \"\${PWD}\":/src hytssk/doxygen'" >> ~/.bashrc
$ source ~/.bashrc

이렇게 하면 간단하게 Doxygen을 사용할 수 있다.

Doxyfile 생성

$ doxygen -g

문서 작성

$ doxygen Doxyfile

명령줄 매개 변수의 Doxyfile은 다음과 같이 생략할 수 있습니다.

$ doxygen

총결산

이렇게 하면 Doxygen을 쉽게 사용할 수 있을 거예요.
평소 Doxygen을 사용할 때 다음과 같은 절차가 있다.

원본 코드를 편집하고doxygen에 대한 주석을 쓰기

Docker Quickstart Terminal 시작

소스 코드가 있는 디렉토리로 이동

$ cd /c/Users/hoge/Documents/My\ Project

Docker file 생성(이미 존재하는 경우 필요없음)

$ doxygen -g

Docker file 편집(설정된 경우 필요없음)

Doxygen 명령 실행

$ doxygen

생성된 문서 확인

$ start html/index.html

Doxygen을 꾸준히 활용하고 평소에 댓글을 잘 쓰는 습관을 기르세요!