ソースコードの文書化のために Headerdoc と Doxygen を見てきましたが、どちらも最初に開発者がほとんどの作業を行う必要があるようです。Visual Studio では、型を入力\\\すると、メソッドが期待するパラメーターを含むドキュメントのスケルトンが生成されます。名前とパラメーターに基づいてメソッドが何をするかを推測するGhostdocもあります。Xcodeに似たものはありますか?
4283 次
3 に答える
1
Appledocもあります。これは、Appleのドキュメントと同じように見える、ソース、ドキュメントセット、htmlのコメントからさまざまなドキュメントを作成します。
于 2011-12-26T15:19:11.543 に答える
1
VVDocumenterプラグインを使用できます。これは、XCode ドキュメント用の非常に便利なプラグインです。
その後、文書化したいメソッド (または任意のコード) を見つけて を入力する///と、文書が生成され、すべてのパラメーターと戻り値が Javadoc スタイルに抽出されます。これは、Appledoc、Doxygenと互換性があります。 HeaderDoc . インライン プレースホルダー トークンを入力するだけで、ドキュメントを完成させることができます。
于 2014-12-24T00:47:33.980 に答える
0
次のコマンドで簡単に実行できるXCode パッケージ マネージャー: Alcatrazをダウンロードします。
curl -fsSL https://raw.github.com/supermarin/Alcatraz/master/Scripts/install.sh | sh
XCode を再起動すると、ウィンドウのツールバー メニューに「Package Manager」という新しいオプションが表示されます。そこからVVDocumenterをインストールできます。
VVDocumenter をインストールしたら、XCode を再度再起動する必要がありますが、Xcode をリロードした後、/// と入力すると、後でドキュメントを作成するために使用されるコメントの作成に関するヘルプが表示されます。
于 2014-08-29T05:14:32.570 に答える