documentation

0熱

4答えて

私たちのクライアントが15ヶ月間作業していたプロジェクトをキャンセルする可能性が高いようです。ある時点で再起動される可能性は非常に低いですが、それは可能です。私たちはまた、これを実行しながらいくつかの分野で当社の製品を拡張しました。他のプロジェクトチームも同様の拡張を行う必要があるかもしれませんし、私たちが行ったことを利用できるようにしたいと考えています。将来のチーム（異なる人員を含むかもし

1熱

4答えて

qpThreadsのドキュメント

qpThreadsに関するドキュメントはありますか？どのようにpthreadsと違うのですか？

9熱

6答えて

Eclipse：すべてのクラスのメソッドと変数のリスト

他の人が書いたJavaコードを使用し始めています。私はそれを理解し、変更し、テストしなければなりません。著者は現在利用できません。パッケージには、異なるサイズの約50のファイル（およびクラス）があります。メソッドの名前（パブリックとプライベート）とパブリック変数（Eclipseのアウトラインウィンドウに表示されているようなもの）を見たり印刷したりすることができれば嬉しいです。私はこれを見て、各クラ

7熱

4答えて

XMLドキュメントインターフェイスの実装とクラスの実装

XML Documentation Commentsを使用してアセンブリを文書化しています。Sandcastleを使用してchmファイルが作成されます。私のアセンブリにはさまざまなインターフェイスが含まれています。それぞれのインターフェイスは1つのクラスで実装されています（私のシナリオではこれらはWCFサービスです）。私はインターフェイスにドキュメントを追加しました。実装するクラスの関連するメ

5熱

4答えて

doxygenの関数の中からコメントを抽出するにはどうすればいいですか？

doxygenが生成されたhtmlファイルにそれらを入れることができるように、関数（c、C++、java）にいくつかのコメントを付けることができるかどうか知りたいです。例えば： function(...) { do_1(); /** * Call do_2 function for doing specific stuff. */ do_2(); }

11熱

6答えて

ヘルプ作成ツール

私は、このような要件を満足するヘルプ/ドキュメント生成ツールを探しています：それは、C＃コンパイラまたは（より良い）によって生成さXMLDOCのコメントをサポートする必要があります MS Word文書のインポートをサポートする必要があります。概念的なドキュメントからソースコードから生成された参照ドキュメントへのリンクの作成をサポートする必要があります。それはMS Wordの詳細に概念的なド

3熱

4答えて

Doxygenを使用したQt形式のドキュメント？

DoxygenでQt形式のドキュメント（TrolltechのC++ QtまたはRiverbankのPyQtドキュメント）を作成するにはどうすればよいですか？私はPythonを文書化しています。私はそれが生成するデフォルトの機能の概要を改善したいと考えています。特に、私は戻り値の型（ユーザー指定可能）と関数の概要のパラメータを見ることができます。例えば： Functions: int

11熱

10答えて

ドキュメンテーションコメントの冗長性を避けるにはどうすればよいですか？

私はちょうどStyleCopを使い始めました。私が苦労していることの1つはドキュメントの必要条件です。私はツールの有用性について議論したくありません。誰かが実際に有用なコメントを作成する方法を文書化するためのガイドラインや考え方を持っているのかどうかは不思議です。 /// <summary> /// Gets a dto of personal info. /// </summ

2熱

1答えて

.NET XMLドキュメントの参照接頭辞

XMLコメントを使用してクラスライブラリのすべての型、メソッド、プロパティなどを完全に文書化しようとしていますが、cref属性（seeタグ例えば）。 this MSDN pageのアドバイスと、MSDNや他のウェブサイトのさまざまな例を参考にして、crefタグを使って基準値を指定するときはいつも、それにrefresを分類する特定のマーカーを付ける必要があります： 'は型、' M： 'はメソッド）。

0熱

2答えて

SQL Server用のプログラム/プラグインのXDOC（またはC＃相当）スタイルは何ですか？

私はXDOC（またはC＃相当）のような有用なドキュメントalaに情報を抽出できるように、ストアドプロシージャコードを適切にコメントする方法を探しています。軽い方が理想的でしょう。 SQL XML Documentation それはあなたがどのようにあなたがすることができますを示しています。あなたはすでにXMLに基づいてドキュメントを生成するためのサンドキャッスルを使用している場合