問題タブ [documentation-generation]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票する
9 に答える
9859 参照

php - PHPDocよりも優れたものはありますか?

PHP同じドキュメント構文を読み取るが、より豊富な出力を提供するツールはありますかPHPDoc?

0 投票する
9 に答える
53514 参照

php - 自動 PHP ドキュメント生成?

ActionScript 2 では、NaturalDocsを使用しました。ただし、PHP のサポートはかなり貧弱です。これまでdoxygenphpDocumentorを見てきましたが、私の意見では、それらの出力はかなり醜いです。PHP の自動ドキュメント生成の経験がある人はいますか? javadoc スタイルのタグを使用できるようにしたいと考えています。これらのタグは、記述が短く、覚えやすいものです。

0 投票する
9 に答える
571 参照

lisp - Common Lispのライブラリの文書化され、整理されたコレクションはありますか?

私は主にJavaで教えている学校の大学生です。私が非常に楽しんでいるJavaの長所の1つは、ライブラリの膨大なコレクションです。これらのライブラリを特に有用なものにしているのは、JavaDocを介して提供される広範なドキュメントと構成です。これらの品質を備えたCommonLispのライブラリコレクションはありますか?また、これらのライブラリの構築、維持、または拡張を支援するJavaDocと同様のツールはありますか?

0 投票する
3 に答える
4749 参照

c# - .NET でメンバーを文書化するためにインライン コメントを使用する方法は?

.Net でメンバーをインラインで文書化するにはどうすればよいですか? 説明させてください。コメントからドキュメントを抽出するほとんどのツールは、メンバー宣言の後に簡単な説明を追加できるインライン ドキュメントをサポートしています。何かのようなもの:

C# または .NET 言語でこれを行う方法はありますか?

0 投票する
11 に答える
12838 参照

uml - ドキュメント用のGraphviz

doxygenがダイアグラムの作成にgraphvizライブラリを使用していることに気づきました。ドキュメントの生成にgraphvizを使用したことがありますか?doxygenの範囲外の文書化の目的でgraphvizを学ぶ価値はありますか?それとも、Visioのような標準のデータモデリングパッケージを使い続けるほうがいいですか?

グラフライブラリとしてのメリットは理解していますが、より複雑なUML(または同様のもの)を表現しようとする場合でも、調査する価値はありますか?

0 投票する
6 に答える
2867 参照

c# - C# プログラミングの XML コメントのヒント

おはよう、午後、夕方、または夜 (タイムゾーンによって異なります)。

これは、C# 内の XML コメントに関する一般的な質問です。私は自分のプログラムにコメントすることにあまり熱心ではありませんでした。私は常に、より詳細な変数/プロパティ/メソッドの命名者であり、コード自体に語らせてきました。かなり紛らわしいものをコーディングしている場合はコメントを書きますが、ほとんどの場合、多くのコメントは書きません。

.NET、Sandcastle、および codeplex のヘルプ ファイル ビルダーの XML コメントについて読んでいたところ、自分のコードを文書化し、自分のコードを掘り下げなければならない人のために素敵で役立つドキュメントを生成したいと思うようになりました。私がもうここにいないときのコード。

私の質問は、標準と慣習についてです。「良い」XML コメントのガイドはありますか? すべての変数とプロパティにコメントする必要がありますか? すべての方法?私は基本的に、サンドキャッスルによって適切なドキュメントにコンパイルされる優れたコメントを書く方法に関するヒントを探しているだけなので、他のプログラマーが私のコードで作業する必要があるときに私の名前を呪うことはありません。

あなたのアドバイスと提案を事前にありがとう、Scott Vercuski

0 投票する
3 に答える
870 参照

c - C構造体を文書化するためのプログラム?

C 構造として記述されているバイナリ ファイル形式 (またはパケット形式) を使用している場合、その構造を解析して、プロトコルに関する適切なドキュメントに変換するプログラムはありますか?

もちろん、構造体には、フォーマットを記述する必要に応じて、配列やその他の構造体などが含まれます。ドキュメントには、おそらくパッキング、エンディアンなどを含める必要があります。

0 投票する
2 に答える
1191 参照

sql-server - データベースの文書化に優先する文書形式は何ですか

私は、MSSQL データベース (オブジェクト、テーブル、テーブル データ) の MediaWiki ドキュメントを生成するアプリケーションを作成中です。

私の質問は、どのドキュメント形式を好むか、または作成する必要があるかです。従うべきアイデアが多すぎるので、あなたの答えが私の優先順位を設定する必要があります;)

(SO に関する他のドキュメント関連の質問があることは知っていますが、それらは主にドキュメントの生成方法を扱っており (方法は知っています)、特定のドキュメントの種類やプラットフォームについては尋ねていません)

編集:コメントありがとうございます。外部キーを解析するので、実際にはすでにテーブル関係があります。ただし、完全な相互参照は少しトリッキーかもしれません;)

ただし、この質問は、Word、PDF、ODF など、ドキュメントの種類を尋ねることを目的としていました。あなたの専門的な要件や好みは何ですか?

更新: 生成されたドキュメントの概要

0 投票する
4 に答える
4598 参照

c - Eclipse で C コードを文書化する方法 (intellisense/javadoc のようなツールチップ)

JavaDoc/Intellisense のようなドキュメントが自動生成されて表示されるように、Eclipse (3.4 w/CDT) で C コードをドキュメント化することは可能ですか?

たとえば、関数名の後に「(」を入力すると、そのパラメータの意味を説明するツールチップを含む最初のパラメータが表示されますか?

ありがとう。