問題タブ [documentation-generation]

サイトをデプロイしたいマルチモジュール プロジェクトがありますが、サイトのデプロイ構成がサブプロジェクトの子モジュールに継承されていないようです。

• 親
  • モジュールA
  • モジュールB

ファイルシステムでは、それらは互いに相対的に配置されています。

私が実行すると：

私の親プロジェクトは、次の場所に適切にデプロイされています。

• scp://devServer/documentation/webwars/

しかし、子モジュールが親の distributionManagement を継承する場合に期待するように、moduleA や moduleB などのサブプロジェクトはそこにデプロイされません。

• scp://devServer/documentation/webwars/moduleA
• scp://devServer/documentation/webwars/moduleB

これが私の親 pom.xml です。いくつかの無関係な詳細とレポート プラグインを削除しました (APIViz と集計を使用して少しファンキーな javadoc プラグインを含め、集計の親 javadoc と子 javadoc が APIViz を適切に使用するようにしました)。

各サブプロジェクト モジュールで明示的な distributionManagement を定義しようとしましたが、何らかの理由で子サブプロジェクト サイトに index.html がありません。

src/site/site.xml や src/site/apt/index.apt のような src/site/ ファイルがありません。

私はこのようなことをしたいです：

しかし、答えは：None...なぜですか？

Sphinx は、一連の ReST 形式のテキスト ファイルから適切なドキュメントを生成する Python ライブラリです。全文検索に使用されるツールではない

また、doxygen / phpdoc ツールについても十分に認識しています。Sphinx を使用して PHP プロジェクトを文書化する方法があるかどうかを調べようとしていますか? または、他の非 Python 言語でさえありますか?

https://www.sphinx-doc.org/en/master/

HTML ヘルプ ファイルを作成できるように、C# コードをコメントで装飾しています。

私はよくインターフェイスを宣言して文書化します。ただし、これらのインターフェイスを実装するクラスは、実装に応じて特定の例外をスローできます。

場合によっては、クライアントは自分が使用しているインターフェイスしか認識していないことがあります。実装者によってスローされる可能性のある例外を追加して、インターフェイスを文書化する必要がありますか?

インターフェイスの実装者がフレームワークのものではなくこれらをスローするように、カスタム例外を作成/文書化する必要がありますか?

これが明確であることを願っています！

ありがとう

編集 2010 年 1 月 4 日: http://blog.mikecouturier.com/2010/01/creating-custom-exceptions-in-net-right.htmlで、これと .NET のカスタム例外に関するブログ投稿を書くことにしました。

RTF ファイルを PDF ファイルに変換するにはどうすればよいですか? Adobe PDF プリンターを持っていますが、それを使用する必要がありますか? もしそうなら、どうすればプログラムでアクセスできますか?

多くのツールが、Webサービスの設計、プログラミング、テスト、商用および無料で利用できます。しかし、ドキュメントの分野で利用できるものは何ですか？WSDLを解析して、HTML（またはPDF）で「人間が読める」ドキュメントを生成できるツールはありますか？

私たちは C++/C# ライブラリを管理していますが、多くのクラスと関数が文書化されていないことに気付きました。

コードを解析して文書化されていないクラスとメソッドを探し、文書化されていないクラス/メソッド/関数のリストを生成するスクリプトを作成することを考えました。

また、不足しているドキュメントの dOxygen タグを配置するスクリプトも必要です。つまり、そのようなコードが見つかった場合:

それは

もちろん、関数が将来、自動生成されたドキュメント ヘッダーを持っていても、誰もヘッダーに触れていない場合、レポートではドキュメント化されていないと報告されます。

そのようなツールを開発するには、どのスクリプト言語を使用しますか?

アンソニー

Objective Cには、ソースコードからドキュメントを生成できるJavaDocと同様のドキュメントフレームワークがありますか？

重複の可能性:
自動 PHP ドキュメント生成?

私は PHP の初心者であり、現在の仕事では非常に速いペースで言語を習得する必要があります。

私はドキュメンテーションにこだわっています。ドキュメントを書くのも好きです。私は、いくつかの言語で認められているドキュメントの構文とツールに精通しています。

これは PHP には当てはまりません。

文書化可能なソース コード コメントを記述する方法は常に複数あり、通常は言語ごとにさまざまなツールがあることを私は知っています。ただし、私は、標準的なコメント方法や標準の PHP autodoc ツールを義務付けていない環境にいます。これにより、選択の自由が与えられ、それに伴い、分析による麻痺が少し発生します。

phpDocumentor ( http://www.phpdoc.org/ ) は、PHP autodocs の許容可能な標準ツールですか?

PHP コードを文書化するときに、コードに関する一般的な JavaDoc ガイドラインに従うことは許容されますか?

Visual Studioには、Javadocスタイルのコメントのhtmlドキュメントを生成するオプションがありますか？もしそうなら、これを達成するためにどのようなステップが必要ですか？

BlueJには、Javadocスタイルのコメントをhtmlファイルに変換するオプションがあります。

次のBlueJを使用したJavaの写真のように、Visual Studioでも同じことをしたいと思います:(_{ソース：time-tripper.com）}