問題タブ [code-documentation]

私はいくつかの 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

テンプレート化された YARD doc スタイルのコメントを既存の Rails レガシー アプリケーションに挿入できるようにしたいと考えています。現在、コメントはほとんどありません。パラメータが指定されているクラス ヘッダーとメソッド ヘッダー (私が推定するメソッド シグネチャからの抽出による) と、戻り値のプレースホルダーが必要です。

PHP コードには、コードを調べて、コードの適切な場所に挿入されたドキュメント ヘッダー コメントを作成するツールがありました。Ruby と Duck 型付けなどでは、@params の型などを簡単に推測できないことは確かですが、それで問題ありません。挿入後にコード ファイルを 1 つずつ手動で確認することを期待しています。可能であれば、すべてのスケルトン テンプレート (500 以上のファイル) をコードに挿入する必要はありません。

これを行うgemなどを検索しましたが、これまでのところ何も見つかりませんでした。そこに何かありますか？

私は、私を悩ませ続けている小さな問題を抱えています.私は現在、独自のRパッケージを作成しており、明らかにそのためのドキュメント/ヘルプファイルが必要です. これまでのところは問題ありませんが、現在、.rd ファイルで \choose コマンドを使用する方法を考え出そうとしています。.rdファイルを介して作成したPDFに奇妙な出力が生成され続けます。私は現在それを次のように使用しています：

私を届けてくれる

これは明らかに間違っています。choose コマンドを省略すると、ここで必要なものが得られます (もちろん、二項係数はありません)。\choose{s,k}、\choose{s}{k} と考えられる任意の組み合わせを試してみましたが、すべて基本的に同じ出力が得られます。何か案は？

前もって感謝します！

SpriteViewController 内

AppleによるObj-Cで：

私によるSwiftの場合：super.viewDidLoad（）

私はいつも「うまくいきません！:(」。

誰かが私が間違っていることを教えてもらえますか?

プロジェクト全般について詳しく知りたい場合は、こちらを参照してください。

ありがとう！

次のコマンドを使用して、API ドキュメント用に「npm」と「node」をインストールした後、「apidoc」をインストールしました。

apidoc をグローバルにインストールした後、プロジェクト ディレクトリで以下のコマンドを実行しました (apidoc がデフォルトのテンプレート ファイルを考慮すると仮定します)。

その結果、エラーもドキュメントも生成されませんでした。

同様に、私は試しました：

しかし、何も起こりません。その場合、「mytemplate」ディレクトリには何もありませんでした。

インストール/検討するのに見逃したものを教えてください。コマンドの実行時に何も表示されないのはなぜですか？

注: Ruby アプリケーションにこれを使用していますが、アプリケーションを Ruby 1.9 で実行しており、Ruby 2.0 が必要なため、gem をインストールできません。他のプロジェクトでも機能する独立したソリューションが必要です。

ありがとうございました。

doxygen HTML ドキュメント内の関連する 2 つの定義マクロを、1 つの説明ボックスに表示されるように接続したいと考えています。

それがどのように見えるべきかを明確に説明できることを願っています: 通常、すべての define ステートメントは、 を使用して独自の説明ボックスを取得します/** @define <description> */。これにより、ボックスのタイトル行にコード部分が表示され、ボックスの内容に短い説明が表示される説明ボックスが表示されます。

ここでやりたいことは、2 つの define ステートメントを接続して、それらが共通の説明を持つ 1 つのボックスに表示されるようにすることです。誰かがそれを実現する方法を知っていますか?

PS: この ASCII グラフィックを使用すると、少しわかりやすくなります。

+-------------------------+ | #define PORT 1 | | #define PORTDIR 0 | +-------------------------+ | output port definitions | +-------------------------+

XCode 用のこのプラグインを見つけたのですが、XCode にそのような機能が既に実装されているかどうかを知りたいですか?

PHPStorm では、/**+Enter を入力するだけで、関数のすべての変数が事前に入力されたコメント ブロックを自動作成する必要があるためです。