code-documentation

    3

    2答えて

    私たちは開発チームであり、私たちのコードを文書化する必要があります。 各開発者は、モジュールと呼ばれるコードの一部で動作します。 我々は彼女/彼自身の作品 各開発者のドキュメントを実装し、使いやすくする必要がありますし、他の開発者が任意のモジュールについて知る必要がある場合、彼/彼女は「shouldnこの仕様 を持っているドキュメントが必要オリジナルの開発者にドキュメンテーションについて尋ねる義務

    1

    3答えて

    私は、内部のバックエンドクラスを使用して、次のパブリックインターフェイス public interface Bar{ public void DoStuff(); } internal class BarImpl : Bar{ public void DoStuff(){ // throw exception if invalid state // d

    8

    2答えて

    ReSharper 6.0 with ReSharperを使用しています。 メンバーにはドキュメントヘッダーが必要なStyleCopルールを使用していますが、ReSharperのコードクリーンアップ機能ではドキュメントヘッダーが生成されることは避けられます。 Bad docヘッダーは、最初に追加されたものよりも更新される可能性が低いため、何も表示されません。 ReSharper => Option

    7

    2答えて

    NSNotFoundためこの中に、Xcodeのドキュメントはかなり混乱して: それは "8.4経由のiOS 2.0で利用可能" と ":iOSの8.1〜8.0可用性" と言います。だから... それは8.0より前に利用できますか?または9.0 +で?それがあれば、ここで何が起こっているの?

    0

    1答えて

    jsdocを使ってこのコメントを正しく作成するにはどうしたらいいですか?何か案は??? /********************** * @variables : global variables ***************************/ var map; // this var handle the object related with the map var ima

    13

    4答えて

    Cでコメントを書く方法がわかりません。私は//と/* */について知っていますが、いい意味でどこでいいのでしょうか?私は関数を持っている場合と同様に、それはJavaで行われているように@param variable is the value bla blaをどのように書くのですか? これに関する基準はありますか?あるいは、Javaでやっているようにしてもいいですか?あなたはドキュメントを生成したい

    4

    2答えて

    私の質問はPythonに向けられていますが、JavaScriptやその他のスクリプト言語に関するものでもあります。 私は通常、静的型付けされた言語(Java、C++、ActionScriptなど)で開発しています。 私は時々Pythonを使うのが好きで、JavaScriptを使う必要があることもあります。これらは動的型付き言語です。それには何も問題はありませんが、私は通常、関数やメソッドにどのパラ

    0

    2答えて

    まず、PHPソースからドキュメントを生成する方法については問いません。これはDoxygenやPHPDocumentorのようなライブラリでは簡単です。私が探しているのは、クラス、メソッド、プロパティなどのインラインphpdocベースのコメントスタブを自動的に生成する方法です。これを行うことができる既存のライブラリがありますか?私は少し調べて、何も出てこなかった。 私はかゆみがあるので私は尋ねるだけ

    0

    3答えて

    私はhttp://www.phpdoc.org/を見ていますが、皆さんが役に立つと思っているものは不思議です。私はコードを文書化するのに役立つものだけでなく、サイトで頻繁に実行される手順やタスクも欲しいと思っています。 linux/PHP/MySQL環境でこれに最適なソリューションは何ですか?