問題タブ [code-documentation]

Cでコメントを書く方法が見つかりません。つまり、私は知っているということ//です/* */。つまり、どこで良い習慣を見つけることができるのでしょうか。関数がある場合の@param variable is the value bla blaように、Javaで行われるように、どのように記述すればよいですか？

これに関する基準はありますか？それとも、Javaで行うのと同じように行うことができますか？

Mozilla のオンライン ドキュメントは優れていますが、インターネットに接続できない場合があり、o'reilly の JavaScript 決定版ガイドの参照も優れていますが、便利な検索機能がありません。

railsapi、またはyard、またはjQAPIのような javascript 用の何かがあるのだろうか

私は次のパブリックインターフェイスを持っています

内部バックエンドクラスを使用

質問：

• インターフェイスのみBarImplを実装しBarます。
• BarImplDoStuffメソッドで例外をスローできます。

これらの例外をBar.DoStuffxmlドキュメントに文書化することは意味がありますか？

前もって感謝します、

PEAR インストールで PHPDocumentor をインストールしようとして成功しなかった後、公式 Web サイトで説明されているように手動で試しました: http://www.phpdoc.org/docs/latest/for-users/installation.html

ファイルをダウンロードし、/usr/bin/ にエイリアスを作成しましたが、ターミナル y 経由で phpdoc.php を実行しようとすると、エラーが表示されます。

これは私が試すものです：

そして、これはエラーです：

私は Mac Os X を使用しています。ご覧のとおり、MAMP を使用して Apache を実行しています。何が起きてる？存在しないファイルを開こうとするのはなぜですか? (実際には PHPDocumentor フォルダー内に存在しないため)

ありがとう。

私の質問はより Python 向けですが、JavaScript やその他のスクリプト言語に関するものかもしれません。

私は通常、静的に型付けされた言語 (Java、C++、ActionScript など) を使用して開発を行っています。

私はときどき Python を使用するのが好きで、JavaScript も時々使用する必要があります。これらは動的型付け言語です。それは何も悪いことではありませんが、通常、関数やメソッドで必要なパラメーターを理解するために多くの頭痛の種があります。いくつかのdocstringを含む自分のコードであっても発生します! おそらく、目は関数の定義以外のどこかを見なければならないからです。

もちろん、答えはドキュメントにあるはずです。しかし、まったく明確でない場合や、ダックタイピングを使用しているため、ドキュメント自体を書くのが難しい場合があります(「最初のパラメーターは、arg がは文字列です」）。私が非常に望んでいるのは、言語自体の内部に一種の引数の記述があることです (たとえそれが ActionScript のようにオプションであっても)。

関数/メソッドの引数を明確に説明するためのベスト プラクティスは何ですか?

特別なデコレータ (Python を使用している場合) を作成して、それを使用するときにデータの型をチェックすることについてはどうですか (ただし、書き込み時ではなく実行時に使用されるため、とにかくポイントは何でしょうか)?

問題にすべきではないと思いますか？現在のdocstring以上のことをすると開発者が混乱するのでしょうか、それとも私の心があまりにも静的な型付けを重視しているのでしょうか?

ビューの目的を簡単に説明したコメントをビューに作成したいと思います。残念ながら、Oracle のビューにコメントを作成することはできません。この機能は、使用可能なテーブル、列、およびマテリアライズド ビューでのみ使用できます。データベース ビューをどのように説明していますか?

.net キーワードで F1 を押すと、そのキーワードのヘルプが表示されます。ドキュメントを含む.netライブラリがあります。このライブラリを使用しています。このライブラリの関数で F1 を押したときに、F1 でライブラリ ヘルプにアクセスするにはどうすればよいですか?

一般に、ローカル ドキュメントを .net ドキュメントとマージするにはどうすればよいでしょうか。

I'm writing my own library for the project at work for a browser application and I am having the same old problem deciding how to comment the code.

I'm trying to follow the JsDoc syntax, but will probably continue the Google Closure Compiler way. I may end up using two @return and @returns tags in the documentation, just for portability sake (when I setup the auto-generation of the documentation).

Now, the question, how do you document the return of a custom anonymous object from a function? For example:

JsDoc has an example of how a @param can be documented to expect object with certain fields, but not the @returns tag. Similarly, the Google Closure Compiler documentation of a Record Type is vague and has no example to work it out.

XML とSandcastle Help File Builderを使用してHtmlHelp1ヘルプ ファイルを生成するC# コードを文書化しています。C# に関連するコード構文のみを生成したいのでSyntaxFilters、Sandcastle プロジェクトのプロパティを に設定しました。CSharp

次のようなを使用<see langword="[langword]" />しています。

SyntaxFiltersプロパティをに設定したCSharpので、次のように、上記のタグが同等の C# キーワードに変換されることを期待していました。

代わりに、次のように、Visual Basic の同等のキーワードに変換されます。

これらのタグを Visual Basic キーワードではなく適切な C# キーワードに置き換える方法はありますか? または、see タグをまったく使用しないでください。

最近、StyleCop 4.7.34.0 (R# プラグインを使用) を使用して R# 6.1 (フルではなく C# バージョン) をインストールしました。プロジェクトに新しいクラスを追加すると、ファイル ヘッダー情報が自動的に追加されます。これを無効にするにはどうすればよいですか？

StyleCop の R# オプション ([オプション] > [ツール] > [StyleCop] > [ヘッダー] セクション) 内の [ドキュメントとファイル ヘッダーにテキストを挿入] のチェックボックスをオフにしましたが、まだ運がありません。

また、ヘッダー ドキュメントを必要とする StyleCop ルール SA1633 から SA1640 もオフにしました。

次の関連記事を見つけました。

ReSharper -> オプション -> ツール セクション -> コードのクリーンアップ -> StyleCop プロファイルを選択 -> ドキュメント セクション -> 1600 のチェックを外す

ツールセクションに「コードクリーンアップ」ノードがありません。私がR#の「C#」バージョンを使用しているという事実がそれと関係があるかどうかはわかりません。