問題タブ [code-documentation]

ウィキペディアのページ (ドキュメント ジェネレーターの比較) で、pandoc をドキュメント ジェネレーターとして使用できることを見ました (doxygen のように)。

しかし、他のドキュメント ジェネレーターのように、pandoc のドキュメントやそのサイトで、ソース コード コメントからドキュメントを抽出する方法を見つけられませんでした。

では、これを行うためにpandocを使用するにはどうすればよいですか? コード コメントから pandoc のマークアップ言語を抽出し、そこから PDF または HTML ドキュメントを作成する方法はありますか? それとも、ウィキペディアの比較リストが間違っていますか?

OpenCV最近、 でライブラリを使いたいのですが、 のバインディングのPythonドキュメントが非常に不明確で不十分です。のバインディングに関する詳細なドキュメントがどこにあるのか知りたいです。以前は で使用していましたが、ドキュメンテーションは非常に役に立ちます。さらに、疑問に思っていたソース コードに移動することもできます。しかし、バインディングのソース コードからは多くの情報が得られないと思います。たとえば、フラグがモジュールにあることを見つけるのに長い時間がかかりますが、フラグはモジュールにありますPythonOpenCVPythonOpenCVOpenCVC++PythonCV_8UC1cv2.CV_8UC1CV_CAP_PROP_FPScv2.cv.CV_CAP_PROP_FPS.

以下の両方のスタイルのコメントを Doyxgen で読むことができますか?

Doxy ブロック コメントの形式は次のとおりです。

libstdc++ のものは次の形式です。

マクロから派生した値を持つ静的初期化子を持つ C コードがいくつかあります。これらの初期化子は、本質的に私のコードの外部 API です。初期化値が簡単に見えるように、コードのドキュメントを自動生成する方法を探しています。

たとえば、以下は非常に単純化された C プログラムです #include

そのプログラムを考えると、自動生成されたドキュメントを取得したいと思います

1. 変数 myVar には 2 つの要素があります
2. .f フィールドが消費するバイト数
3. myVar の各要素の .fa フィールドの値

gcc -Eを使用して GCC から直接その情報の一部を取得できますが、 .fa の値も sizeof() も数値に完全には解決されません。探しているものを取得する方法についてのアイデアはありますか (できれば Doxygen を使用せずに)?

私は KDE の API リファレンス ページのいくつかを調べていて、具体的には彼らのテクニカル ケースのドキュメントを調べていました。 https://techbase.kde.orgのサブページをナビゲートすればするほど、読みやすさ、無駄のないものを本当に楽しんでいます。 、きれいな、などのデザインです。

techbase.kde.org に使用されたドキュメント ジェネレーターを知っている人はいますか?

AngularJS ディレクティブを文書化するためのアドホックな標準またはツールはありますか? 私たちは再利用可能な機能を明示的に構築しているので、それらのインターフェースを開発者に渡せるはずです。私はいくつかのことを見てきました：

• 闊歩。Swagger 2.0 の方向性は気に入っていますが、ディレクティブを文書化するためにどのように使用されるかは明確ではありません。
• Ngdoc ( https://github.com/angular/angular.js/wiki/Writing-AngularJS-Documentation ) これには、AngularJS チームが使用するツールと同じという利点があります。

人々が見つけたより良い方法はありますか？

X-Codeを2か月から使用しています。他の IDE から慣れ親しんだ特定の機能を検索する必要があるため、低値と高値があります。

ここで、コードの文書化について質問があります。

Eclipse で Java を開発して以来、(/** + Enter) メソッドのドキュメント コメントを自動生成するのに慣れているようですが、これは X-Code では機能しません。同様の方法はありますか、それともコメントブロック全体を自分で書く必要がありますか?

素早い入力ありがとうございます。

乾杯

PHP スクリプトのすべての vars/consts/functs/classes/includes を文書化するための安価なツールを見つけることができなかったので、独自のツールを作成しています。(私は、変更が必要なオープン ソース スクリプトを多数使用しています。さらに、自分のプロジェクト用のディレクトリがあれば便利です。)

私はphp文字列関数を使用して1つをまとめ、すべての定数を見つけ、スクリプトの各行を走査し、行番号を配列にロードし、次にincludes/requires、変数などをロードしました.これは約90％を取得します.私が欲しいもの。ただし、それを改善する場合は、php コンパイラーがおそらく行うように、スクリプトを文字ごとに処理するアプローチを変更することになるでしょう。この問題を解決する方法を知っている人はいますか? この車輪を発明しなければならないなんて信じられない...

この機能が組み込まれているプログラミング環境があると思いますが、私は古い学校で低予算です。そして、そうです、OO とタイトな機能により、ほとんどの var を文書化する必要がなくなりますが、include/require ツリーを確認したり、グローバルを文書化したり、クラスのすべてのインスタンスがどこでどのように使用されているかを確認したりする必要があります。

次のコマンドを使用して、デバイスを USB 経由で Android Debug Bridge (ADB) に接続すると、次のようになります。

次に、次の (暗号化された) 16 文字を取得します。

これらの文字は何ですか? それらは Windows または ADB によって生成されますか? それらの文字は一時的に保存されているか、別の場所に表示されていますか?

私はいくつかの REST サービス (アプリケーション/json の消費と生成) を持っており、@TypeHintドキュメントの生成に使用しています。

今、私はこのようなものを持っています:

しかしMyResponse、のラッパーList<MyType>です。

私のbuildメソッドはMyResponse次のようになります。

List<MyType>の代わりに直接使いたいMyResponse。TypeHint次のコードで使用する最良の方法はどれですか?

私は次のオプションを考えていました：

1. @TypeHint(List.class)
2. @TypeHint(MyType.class)
3. @TypeHint(List<MyType>.class)-> 残念ながら、これは Java 型消去のために機能しません。

質問：

番号 3の有効な代替手段はありますか?

タイプが a であっても、自分のタイプに注釈を付ける必要があり、それは変更できないためList、番号1は役に立ちません (JDK からのものです)。@XmlRootElementList

番号2には回避策がありますが、完全ではありません。

• 番号 2 を使用します (生成された HTML ドキュメントで使用可能な例を使用するためだけです - そのリストに含まれる要素の説明)

• ListJavadoc 内にあることを指定します(例:@return単語の後ろ) (HTML タグを介して太字、色、斜体などを使用して強調できます)

  例えば：

  /li>

詳細：

• enunciate.version = 1.30.1
• Java 7