2016-11-19 2 views
2

現代のプログラミング言語の多くは、ドキュメンテーション文字列としてコメントシステムをサポートしています。Dはドキュメント生成をサポートしていますか?

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

私はDプログラミングにかなりの初心者午前:

この機能は、そうでない場合は明確ではない場合があるドキュメントの文字列は関数の目的を理解するのに有用である可能性がPythonやClojureの、のような言語では当たり前のさしかし、クライアントにアクセス可能な方法でドキュメンテーション文字列コメントを書くためのドキュメントはまだ見つかりませんでした(例えば、Pythonのhelp(gen_ast))。 Dはドキュメントストリングをサポートしていますか?

答えて

3

はい。 コマンドライン上のオプションについてhttp://dlang.org/spec/ddoc.html

:コードから取得するには http://dlang.org/phobos/std_getopt.html

:コード自体については

http://dlang.org/spec/attribute.html#uda

はしかし、というドキュメントをPOUTに公平ですコメントはコード内で直接アクセスすることはできません - あなたはUDAまたはgetoptライブラリのドキュメント文字列としてそれを行うか、コメントを抽出するためにビルドセット内に別のコマンドを持たなければなりません(dmd -Dによってdmd -D -Xはそれらをjsonに変換します。それを解析します)

+0

コンパイルされた言語でhelp()と無関係の良い点...私はまだreplを使わずに人生に適応しています。 –

1

@Adam D Ruppeの答えは、最初のリンクから抽出された関連コンテンツです。正式な仕様ですDドキュメンテーションの生成。

次のようにまず、リターン機能のが指定されています

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

しかし、私はとの文書が不明確た:第二に、例が必要と似た方法で

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

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

指定されています自動文書生成のためにこれらの規則を使用する能力に関する。

関連する問題