닥스트링

프로그래밍에서 docstring은 코드의 특정 세그먼트를 문서화하기 위해 주석과 같이 소스 코드에 지정된 문자열 리터럴이다.기존의 소스 코드 주석이나 심지어 자바독 문서와 같은 특정한 형식의 주석과는 달리 문서화는 구문 분석할 때 소스 트리에서 벗겨지지 않고 프로그램의 런타임 내내 유지된다.이를 통해 프로그래머는 이러한 의견을 런타임에 검사할 수 있으며, 예를 들어 대화형 도움말 시스템 또는 메타데이터로서도 검사할 수 있다.

Emacs의 TECO 본래의 시행에 처음 도입된 것으로 보인다.^[1]

문서작성을 지원하는 언어는 파이톤, 리스프, 엘리시르, 클루주르,^[2] 게르킨, ^[3]줄리아^[4], 하스켈 등이다.^[5]

구현 예

엘리시르

문서화는 문서화의 형태로 언어 수준에서 지원된다.Markdown은 Elixir가 문서 작성에 사용하는 사실상의 마크업 언어다.

반항하다 모듈 마이모듈 하다   @modifiedoc """ 내 모듈에 대한 문서.**포맷**과 함께. """    @doc "여보세요"   반항하다 세계 하다     "세계"   종지부를 찍다 종지부를 찍다 

자바스크립트

JavaScript에서 JSDoc은 문서화 목적으로 소스 코드 파일에 주석을 달 때 사용되는 마크업 언어다.

/** * 두 개의 숫자를 추가하고 결과를 반환한다. * @param {number} 첫 번째 숫자. * @param {number} b 두 번째 숫자. * @returns {number} a와 b의 합. */  경시하다 덧셈을 = (a, b) => a + b; 

리스프

Lisp에서는 문서 문자열을 문서 문자열이라고 한다.Common Lisp 표준은 특정 구현이 어떤 이유로든 그들이 원할 때마다 문서를 폐기하는 것을 선택할 수 있다고 명시한다.문서를 보관할 때 DOCATION 기능을 사용하여 문서를 보고 변경할 수 있다.^[6]예를 들어,

 (반기를 들다 foo () "안녕 거기" 못을 박다)  (문서화 #'foo '기능') => "안녕 거기" 

파이톤

정의의 맨 앞에 있는 코드 객체를 문서화하는 일반적인 관행은 Python 언어의 docstring 구문 추가에 의해 포착된다.

Python 코드 객체(모듈, 클래스 또는 함수)에 대한 문서 문자열은 정의('def' 또는 'class' 문) 바로 뒤에 있는 해당 코드 객체의 첫 번째 문장이다.그 진술은 다른 어떤 종류의 표현이 아니라 맨 문자열 문자 그대로여야 한다.코드 객체에 대한 문서 문자열을 해당 코드 객체의 문서에서 사용할 수 있음__doc__을 통해 귀속시키다.help기능을 발휘하다

다음 Python 파일은 Python 원본 파일 내의 문서 문자열 선언을 보여준다.

"""모듈 문서 문자열""  계급 마이클래스:     """수업의 문서 문자열""      반항하다 my_properties(자아의):         """방법의 문서 문자열""  반항하다 my_function():     """함수의 문서 문자열"" 

위의 코드가 다음과 같이 저장되었다고 가정할 때mymodule.py, 다음은 문서 스트링에 액세스하는 방법을 보여주는 대화형 세션이다.

>>>수입하다 마이모듈 >>>돕다(마이모듈) 모듈의 문서 문자열 >>>돕다(마이모듈.마이클래스) 수업의 문서 문자열 >>>돕다(마이모듈.마이클래스.my_properties) 메서드의 문서 문자열 >>>돕다(마이모듈.my_function) 함수의 문서 문자열 >>> 

문서를 사용한 도구

• 코브라 -doc(코브라)
• Doctest (Python)
• 에피닥 (피톤)
• 파이닥 (피톤)
• 스핑크스 (피톤)

참고 항목

• 리터럴 프로그래밍 – 대체 코드 커멘팅 패러다임
• 일반 구 문서 – Perl 문서

참조

외부 링크

• Epydoc의 SourceForge 페이지의 Python Docstrings
• GNU Emacs Lisp의 문서화
• Python 문서 스트링에 대한 Doxygen 설명서의 섹션