問題タブ [documentation-generation]

Python 用のドキュメンテーション ツールはたくさんあるようです。私が遭遇した別のものはepydocです。Sphinx は、公式の Python ドキュメントを生成するために使用されているため、デファクト スタンダードのようです。誰かが私のために Python のドキュメンテーション ツールの現在の状態を整理してくれませんか?

私はこのフラグメントを機能させようとしています：

つまり、includeディレクティブを使用して、ファイルがブロック引用符として含まれるようにします。ブロック引用符の中に入ると、ディレクティブが引用符で囲まれます。ファイルの内容をブロック引用符で囲んでください。

これを行う方法はありますか？

ドキュメントを生成するための Doxygen を認識しています。私が探しているのは、Java ファイルを編集するときに Eclipse が行うのと同様に、Xcode にドキュメントを挿入する簡単な方法です。

次のようないくつかの引数を持つ目的の c メソッドがあるとします。

Eclipse では、カーソルをメソッドの上に置いて次のように入力すると、 とタグ/**<Enter>が事前に設定された Javadoc テンプレートが取得されます。@param@return

Xcodeで同様のことを達成することは可能ですか? と入力した後/**<Enter>、これを自動的に取得したいと思います：

私はepytextからreSTマークアップへのコンバーターを作成しました。今、ライブラリ全体のすべての docstring を epytext から reST 形式に変換したいと考えています。

モジュール内のすべての docstring を読み取り、置換を書き戻すスマートな方法はありますか?

ps:おそらくastモジュール?

これを行う方法があるのだろうか、それともそれを行うべきなのだろうか？メタデータの一種であるため、すぐにメソッド属性を使用することを考えましたが、この目的のためにメソッド属性があるかどうかはわかりません。現在、私はXMLコメント<remark>タグを使用して、メソッドがインターフェイスを実装するタイミングを通知しています。しかし、これはもちろん、構造化された形式のメタデータではありません。

自動化されたコードドキュメンテーションシステムは、コードを介してこの情報をすでに解析できるかもしれませんが、実際のコードを読んでいる人にとっては、それをより簡単に追跡するのに役立つ可能性があります。

私は非常に大規模なソフトウェア プロジェクトに取り組んでいるチームと協力しています。ハイパーリンク インデックスや検索機能のない MS WORD 形式で書かれた大量のドキュメントがあります。私たちは毎日、正確な文書や参考文献を見つけようとして時間を無駄にしています。

これらすべてを wiki 形式に変換する方法、または専門的なツールさえあれば、少しマニュアル (面倒な) の助けを借りて、アクセシビリティを向上させるものに整理できるかどうかを考えていました。Google デスクトップ サーチを使用して生活を少し楽にしていますが、最善の解決策ではありません

同様の問題に直面した方がいるかどうか、またこの問題の解決策を知りたいだけです。

私は最近多くの VC++ 2008 / CLI ソフトウェアを作成しており、C#/CLI スタイルのドキュメントを使用しています。

私はこれらのブロックをかなり頻繁に再入力していることに気づきました。率直に言って、それは繰り返しになっています。新しい関数定義を作成したり、既存の定義を更新したりするときに、Visual Studio でこれらのブロックを自動的に作成/更新する方法はありますか?

私たちは、asp.net c# を使用して非常に複雑な e コマース ポータルを開発しています。クライアントから、ドキュメントをeBay API ドキュメントと非常によく似たもの (ルック アンド フィール) にするように依頼されました。

彼らが使用しているツールの種類を知っていますか? そうでない場合、同様の結果を生成するように構成できるものを知っていますか?

Symfony [symfony-project.org] フレームワーク (つまり PHP) で記述された REST ベースのサービスがある場合、コードを解析して API ドキュメントを生成する適切なツール/フレームワークはありますか?

Java ベースのフレームワーク enunciate には、私が必要としているものと同様のドキュメント機能があります。この例は、http: //enunciate.codehaus.org/wannabecool/step1/index.htmlで確認できます。

I understand the premise of REST based services are supposed to be self evident, however I was after something that would generate this documentation for me without the need to manually write up all my endpoints, supported formats, sample output etc.

Thanks

きゅうりのシナリオから、エンド ユーザー (潜在的にはオンライン、潜在的には印刷) のヘルプ/ドキュメントを作成しようとした人はいますか? または、RSpec と Selenium RC の機能を使用して、ドキュメントで使用するためにスクリーンショットを撮りましたか?

Cucumber については、次のようなものを想像しています。

ドキュメントへの翻訳:

リンクを追加する場合は、ブログ投稿の編集ページに移動します。「リンクを追加」ボタンを押して、「http://stackoverflow.com」などの URL をリンク URL フィールドに入力します。「OK」をクリックします。

1 つは Cucumber の機能をドキュメントに解析するための何かを書き、2 つは優れたドキュメントを作成するような方法で Cucumber の機能を記述/構造化することです。結果として生じるドキュメンテーションは、構造に大きな変化がなければ、本当に退屈に聞こえるでしょうか?

このアイデアのようなものは他にありますか？doxygenは、エンドユーザー向けのドキュメントというよりも、コードのドキュメント向けのようです。

スクリーンショットを自動的に撮るのはどうですか？これはより実り多い道のように思えます.RSpecテストが失敗したときにスクリーンショットを撮るコードを再利用し、所定の状況でスクリーンショットを撮るようにしてください. これを行うより良い方法はありますか？