본문 바로가기

Study/Development3

Python 문서화 (1) - Sphinx 설치 및 docstring 스타일 선택 Sphinx 란? Python documentation 을 위한 오픈소스 프로젝트 입니다. Java Doc 처럼 파일, 클래스, 기능별로 문서화할 수 있으며, comment를 자동 인식하여 기본적으로 html 페이지를 생성합니다. Sphinx에서는 comment를 무조건 다 인식할 수 있는게 아니라 인식할 수 있는 docstring 스타일이 존재합니다. 기본적으로 reStructuredText (rst) 포맷을 주로 사용하지만 Google 스타일도 있기 때문에, 스타일의 차이점과 그에 맞는 설정 방법을 설명 드리도록 하겠습니다. docstring 스타일 기본적으로 주석은 """ 을 사용하며, docstring의 대상은 모듈, 클래스, 함수(메소드) 세 가지입니다. 아래 sum( ) 함수를 예로 들어보겠습.. 2022. 3. 22.
Python 3 설치 및 가상환경 구축 본 문서에서는 시스템에 설치되어 있는 Python은 그대로 두고 Python3 를 가상환경으로 구축하는 방법에 대해 소개하고자 합니다. 시스템에 설치되어 있는 것을 건드리다 보면 문제가 발생했을 시 롤백하기가 어렵기 때문에, 가상환경을 사용하는 것을 적극 권장합니다 또한, 가상환경을 사용하면, 여러 버전을 동시에 관리할 수 있으므로 프로젝트에 맞게 구분하여 관리할 수 있습니다 여러 OS 중 CentOS에서 설치 방법 입니다. 약간씩 차이가 날 수 있으니 설치 환경에 맞지 않거나 잘못된 경우 공유 부탁드립니다. Requirements yum 패키지 설치 sudo yum -y install gcc gcc-c++ kernel-devel sudo yum -y install openssl-devel zlib zl.. 2022. 3. 18.
Javadoc 생성 시 한글 깨짐, UTF-8 사용하기 Eclipse에서 Javadoc을 생성할 때 기존 인코딩 에러가 나서 진행하지 못하는 일이 발생한다. MS949을 사용하지 않을 경우 특히 한글을 사용할 경우 이럴땐, UTF-8로 변환하여 Javadoc을 생성해줘야 하는데, Javadoc 생성 마지막 페이지에서 아래 그림과 같은 처리를 해주면 된다. -locale ko_KR -encoding UTF-8 -charset UTF-8 -docencoding UTF-8 2014. 8. 6.
반응형