[💬] doxygen을 아시나요~

[Mr빙그레(mrbinggrae)]

PC로 디시 너무 느려서 검색하다보니깐 

크롬 기반 브라우저에서만 느리다고 해서 파이어폭스로 디시 들어오니깐 쾌적해졌네! (다들 참고해)

오늘은 꿀팁 doxygen 이것이 어떤 물건이냐?

내가 만들고 있는 프로젝트들의 문서화 내용을 토대로 API를 만들어주고 UML도 만들어줌!!

나는 혼자 개발하니깐 필요가 없을 수도 있지만(이미 코드가 머리 속에 있으니)추후에 프로젝트 전체 흐름이 기억나지 않을 때를 대비해서 doxygen을 활용하는 중.

이렇게 UML도 만들어주고

이렇게 API도 만들어줌

설치 방법은 https://luckygg.tistory.com/341

[Doxygen] 윈도우10에서 독시젠(Doxygen) 다운로드 및 설치하는 방법

위 블로그 참고해. 나는 우분투 계열 사용중이라 윈도우에서 설치하는 방법은 몰라서 다른 사람 블로그 링크 걸었음. 

사용 방법

1. 문서화

/// 이렇게 /를 세번 입력하면 문서화가 자동으로 만들어짐. 

나는 스크립트에 주석 저렇게 달려있으면 개발하기 힘들어서 보통 인터페이스에만 저렇게 설명해놓고

인터페이스를 만들지 않은 클래스와 함수에만 개별적으로  문서화를 해두는 편.

2. doxygen 파일 생성

나는 우분투라서 이 명령어가 윈도우에도 먹히는 지 모름.. (컴터가 구려서 가벼운 우분투로 개발하는중)

 doxygen -g Doxyfile 

이 명령어를 입력하면 doxygen 파일이 생성됨.

doxygen 파일을 열어서 아래의 옵션값들을 수정해

# 프로젝트 정보

PROJECT_NAME = "Match3 Game"

PROJECT_BRIEF = "Match-3 게임 프로젝트"

OUTPUT_DIRECTORY = ./Docs

# 입력 설정

INPUT = ./Assets/Scripts

RECURSIVE = YES

FILE_PATTERNS = *.cs

EXCLUDE_PATTERNS = */\.*

# 출력 설정

GENERATE_HTML = YES

GENERATE_LATEX = NO

HTML_OUTPUT = html

EXTRACT_ALL = YES

EXTRACT_PRIVATE = YES

EXTRACT_STATIC = YES

# C# 설정

OPTIMIZE_OUTPUT_JAVA = YES # C#에도 적용됨

EXTENSION_MAPPING = cs=c#

# 다이어그램 설정

HAVE_DOT = YES

UML_LOOK = YES

CALL_GRAPH = YES

CALLER_GRAPH = YES

CLASS_GRAPH = YES

COLLABORATION_GRAPH = YES

# XML 주석 처리 설정

XML_PROGRAMLISTING = YES

지금은 private 함수들도 전부 doxygen에서 보이게끔 만들어놨는데 협업할때는 private를 NO로 설정해도 될듯

doxygen Doxyfile  로 문서화를 한 뒤에

vscode에서 Live Server로 index.html 파일을 열면 됨!

[불타는키보드(1bnmaker)]