D가 설명서 생성을 지원합니까?

Question

많은 현대 프로그래밍 언어는 설명 문자열을 설명서 문자열로 지원합니다.

def gen_ast(s): 
    ''' given a string, s, representing a program, generates object model of abstract syntax tree ''' 
    # function contents here ... 

나는 D 프로그램에 상당히 초보자입니다 :

이 기능은 불분명 수 있습니다 문서 문자열 함수의 목적을 이해하는 데 유용 할 수 있습니다 파이썬이나 Clojure에, 같은 언어에서 당연시되어 , 아직 클라이언트에서 액세스 할 수있는 방법으로 문서 문자열 주석을 작성하는 문서를 찾지 못했습니다 (예 : Python의 help(gen_ast)). D는 문서화 문자열을 지원합니까?

Answer 1

예. 코드 자체에 대한

는 : 명령 행 옵션의 http://dlang.org/spec/ddoc.html

: http://dlang.org/phobos/std_getopt.html

코드에서 활용하려면 다음 그러나 http://dlang.org/spec/attribute.html#uda

,이 문서 밖으로 삐죽하는 공정이다 주석은 코드에서 직접 액세스 할 수 없습니다. UDA 또는 getopt 라이브러리 설명서 문자열로 주석을 작성하거나 빌드 세트에 별도의 명령을 사용하여 주석을 추출해야합니다 (dmd -D는 html로 dmd -D -X를 사용하면 json으로 변환됩니다.)

Answer 2

다음은 @Adam D Ruppe의 답변으로, 첫 번째 링크에서 발췌 한 관련 내용입니다. 공식적인 사양입니다. D 문서 생성. 필요한 경우

둘째

/** 
* Read the file. 
* Returns: The contents of the file. 
*/ 

void[] readFile(char[] filename) { ... } 

는, 예는 비슷한 방식으로 지정됩니다 다음과 같이

첫째, 반환 기능의가 지정

/** 
* Examples: 
* -------------------- 
* writeln("3"); // writes '3' to stdout 
* -------------------- 
*/ 

을하지만, 내가 가진 문서가 불분명 발견 자동 문서 생성을 위해 이러한 규칙을 사용할 수있는 능력과 관련이 있습니다.