問題タブ [phpdoc]
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.
documentation - 「doc」でソースコードを説明しますか？
ソースコードにPHPDocとJSDocを使用しています。それらのドキュメントからAPIを構築するためのツールがあることを私は知っています。しかし、私が疑問に思っているのは、複雑なコードをどのように説明するのかということです。PHPDoc / JSDocで説明するのではなく、関数内で複数行コメントを使用するだけですか？
たとえば、次のコードについて考えてみます。
上記の場合、複雑なコードにコメントするにはどうすればよいですか？JSDocはAPIの構築に使用されるため（「動作方法」ではなく「使用方法」に関するものです）、JSDocではそれができないと思います。
私の仮定は正しいですか：
- JSDoc / PHPDocは、関数/メソッドを使用する人のためだけに書かれています。
- 関数内のコメントは、関数/メソッドの背後にあるロジックを理解する必要がある人のために書かれています。
- ドキュメントはAPIやソースコードのコメントとは別のものであり、（すべてのソフトウェアが提供する必要のある）ドキュメントはソフトウェアを使用したい人のために書かれています。
しかし、私が理解していないのは、アーキテクチャレベルでソフトウェアを説明しているのは何かということです。開発者向けのドキュメントも必要ですか？
ドキュメントを完成させるための戦略は何ですか？
vim - vim phpdoc 複数行コメントの自動インデント
次のようなコメント ブロックがあるとします。
そして、このブロック内で新しい行を開くと、vim で開始したい
しかし、標準 (ubuntu) vim スクリプトの自動インデントは、次のように空の行を開始します。
vimにそれをさせる修正されたスクリプトまたはコマンドはありますか（数年前にこの機能を持っていたことを覚えていますが、今はグーグルできません）？
ティア。
php - 継承されたクラス プロパティの Eclipse で「定義に移動」を有効にする方法
基本クラス (A と呼びましょう) と継承クラス (AA と呼びましょう) があります。
私が持っている別の抽象クラスでは：
より異なるクラスで：
私の問題はMyA、継承クラスでctrl +左クリックすると、元のクラスAファイルに移動することです。AAファイルに連れて行ってもらいたいです。
これを行うPHPdocの方法は何ですか?
php - PHPDocumentorを使用したphpdocコメントの解析
PHPDocumentorの出力をPHPでトラバースできる形式に変換しようとしています（理想的には、すべての関数の配列とそのコメントが必要です）。
これを行う方法はありますか？
autocomplete - phpDocを使用した自動競合
phpDocを使用してIDEのオートコンプリートを支援できると聞きました。誰かがDoctrineでそれを使用する方法を示すことができますか？たとえば、Doctrine_Tableを一連のメソッドで拡張するJobTableクラスがあり、次のように入力したときにオートコンプリートが必要です。Doctrine :: getTable（'Job'）-> ...可能ですか？phpDocなしでそれを行う方法はありますか？
codeigniter - codeigniter を使用した mvc プロジェクトの phpdoc
MVCパターンに従ってCodeigniterでプロジェクトを開発しました。
つまり、たとえば、 Items_model というモデルを呼び出す Items というコントローラーがあり、データベースからファイルを取得し、最終的にそれらのファイルが Item_view というビューに渡されます。
今、私はそれを文書化する必要があり、phpdoc を使用しようとしています。
私の主な質問は、コントローラー内の関数の説明の中で、名前をプレーンテキストで記述するだけでなく、関数の動作をモデルおよびビューと機能的にリンクする方法についてです。パッケージについて読んでいましたが、適切に使用する方法がわかりません
私はあなたが助けてくれることを願っています、私はphpdocに非常に慣れていません。
前もって感謝し、私の英語で申し訳ありません。
スヴェルド。
php - PhpDocドックブロックでNetBeansとSVN@versionタグを使用するにはどうすればよいですか？
私はPHPIDEとしてNetBeansを使用しており、docblockに次のような@versionタグが表示されています。
NetBeansには、コミットごとにこれを自動的に更新する方法がありますか？それとも、このタグの要点を完全に見逃していますか？
php - 可変数のパラメーターを文書化する方法
可変数のパラメーターを文書化するにはどうすればよいですか？私はPHPとJavaScriptでアプリケーションを書いています。現在私は（JavaScriptで）持っています：
では、n-number of string paramsをどのようにドキュメント化するのですか？
php - 保護された属性をphpdocで変更するメソッドを文書化する方法は?
保護された属性をphpdocで変更するメソッドを文書化する最良の方法は何ですか?
たとえば、次の setVar() メソッドを文書化する正しい方法は何ですか?
前もって感謝します、
.L.
php - PHPDoc @property を使用してオートコンプリート用のモデルをロードする
PHP用のCodeigniterフレームワークを使用しています。PHPDoc @property を使用してオートコンプリートのためにモデルにメソッドをロードする方法があるかどうか疑問に思っていました。
私が意味するのは....
Cakephp の作業中に、NetBeans を使用してこのようなことを行いました。CodeIgniterでもそんなことができるのかと思っていました/
よろしく