問題タブ [api-doc]

Sandcastle（ヘルプファイルビルダー）を使用してAPIドキュメントを作成し、それらをVisual Studio 2008に統合したいと考えています。APIを外部（Web）リソースとして統合または追加するにはどうすればよいですか？

PSSQ は、Possibly Stupid Scala Question の略です:)

Scala について少し理解し、必須の Hello World の例 (以下のコード) では、メイン関数への引数は文字列の配列です。

この例ではmap()、配列に対して関数を使用しています。しかし、Scala API ドキュメントを確認すると、map()で使用できる関数の 1 つとしてリストされていませんArray。ある種の魔法が起こっているのでしょうか、それとも API ドキュメントに明らかな何かが欠けているのでしょうか?

クラスがインターフェースで定義されたメソッドを実装する場合、ドキュメントを複製するか、で参照するかを選択できます<see cref="..." />。

APIドキュメントツール（Sandcastle）にドキュメントを自動的にコピーさせることは可能ですか（APIドキュメントをより快適に読むために何が必要ですか）？@inheritDocJava Docのようなものですか？

Pythonコードのドキュメントをクリーンアップしようとしていますが、見栄えが良いのでsphinx-docを使用することにしました。次のようなタグを使用して他のクラスやメソッドを参照する方法が気に入っています。

関数内のパラメーター名を文書化する方法を理解しようとしているので、次のような関数がある場合は次のようになります。

これのベストプラクティスは何ですか？

アップデート：

正しい構文は次のとおりです。

私はswagger uiをダウンロードし、ローカルで実験しました。"path"、"body"、"query" などのシナリオで問題なく機能します。しかし、私のユースケースのほとんどは残りのコメントを使用しています。

つまり、/resourcePath/;tags 特定のリソースのタグを取得するための URI です。

これを試してみると、セミコロンを追加するとUIがごちゃごちゃになり、並べ替えられたUIが不正になり、これを超えることはできません。

これは既知の制限ですか？この目標を達成するための回避策はありますか? これへの入力に感謝します..

FOSRESTBundleでSymfony2.1を使用してAPIRESTfullを作成し、NelmioApiDocBundleを使用して自動ドキュメントを生成しています。

ユーザーが1つのパラメーターを送信する必要があるPUTリクエストがありますが、この目的でフォームを作成する必要はありません。すべてが完全に機能しますが、ドキュメントを生成するときに、「入力」フォームがないため、このパラメーターをドキュメントに追加する方法がわかりません。

私はこれを試しましたが、機能しないようです：

NelmioApiDocBundleのドキュメントでは、これに対する解決策は見つかりませんでした...

デフォルトでは、Swagger はクラスのデータ メンバーを解析して、パラメーターとして使用されるオブジェクト、または特定の Web サービスによって返されるオブジェクトを文書化します。Jackson を使用している場合、Jackson アノテーションは API のより正確な説明を提供します。

Swagger に Jackson アノテーションを解析させる (簡単な) 方法を知っている人はいますか? おそらくオーバーライドされたパーサーですか？

source2swagger は、1 つの json ファイルにすべての API を含む swagger 仕様を生成します。swagger-ui は実際にそれを使用できますか? 生成された json ファイルを swagger-ui で探索すると、単一の json ファイルの説明/操作を使用するのではなく、仕様のパスから API の説明を読み取ろうとします。

Swagger API ドキュメント内には、apis 配列の横にある json 内にモデル オブジェクト エントリがありますが、それに関するドキュメントはありません。この「モデル」部分をどのように使用できますか?

http://apidocjs.com/を使用して、構築中の Express.js API の公開ドキュメントを作成しています。私の質問は、Express.js を使用してドキュメントをルーティングおよび提供するにはどうすればよいですか?

Expressサーバーのセットアップは次のとおりです。

ドキュメントの作成に使用する grunt ファイルは次のとおりです。

すべてのページに対して app.get('.. を宣言せずにドキュメントをホストする方法を知っている人はいますか?どこかのチュートリアルがあれば素晴らしいでしょう。

前もって感謝します。