sdkのswaggerに相当するものは何ですか？

Question

ライブラリやフレームワークを文書化するために人々が使用する標準は多少ありますか？

理想的には、JSONまたはYAMLを使用し、HTMLページを適切に生成できるようにします。

Answer 1

SDKのドキュメントの最も一般的なアプローチは、ソースコード内のコメントからドキュメントを生成することです。このようにして、クラス/関数リファレンスドキュメントを実装と簡単に同期させることができます。

さまざまなプログラミング言語とフレームワーク用のドキュメントジェネレータがあります。 - Sandcastle

• 例
  • .NET：いくつかのツールは

    いくつかの一般的なツールである（など、「はじめに」、概要）を手動で書かれた概念のトピックで生成された参照ドキュメントを組み合わせてみましょう：Sandcastle docs

• ジャワ - Javadoc（JDKの一部）
  • 例：Java API docs
• のJavaScript - jsdoc
  • 例：Adblock Plus JSDoc
• パイソン - Sphinx、具体sphinx-apidoc
  • 例：Python docs
• Doxygenは、C/C++、Objective-Cの、C＃やJava、PHPと他の言語