問題タブ [code-documentation]

サポートされているコメント構文を使用してコードを文書化するために、Xcode 5 の機能を使用しています (この SO の質問を参照してください)。Xcode 6 では、Objective-C ソースでサポートされていますが、残念ながら Swift ソースではサポートされていません。

.swift ソースでインライン ドキュメントを実行したいと考えています。それを行う方法やベストプラクティスはありますか?

前もって感謝します、

ルイス

ウィキペディアのページ (ドキュメント ジェネレーターの比較) で、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 に使用されたドキュメント ジェネレーターを知っている人はいますか?