comment-conventions

0熱

1答えて

まず、私はこの質問に気付いています： Are there standard formats for comments within code? しかし、私は答えませんでした。私がコードを書くときはいつでも、私はいつもコメントが一貫していることを保証する習慣を形作ろうとしますが、それは私のコードフォーマットの規約について決して曖昧なところです。私のコードは80行程度にしたいので特にそうです。言うまで

0熱

2答えて

HTMLコメントの規則

私は、特定のデータを格納するためにHTMLのコメントを使用する必要がありますが、私はすでにDreamweaverのまたはフロントページのようなプログラムによって生成されたとして、存在して使用コメントスキームを望んでいません。どのようなコメントスキームが最も問題ではないか、または少なくとも他の既存のコメント規約と同様に見え

1熱

4答えて

コメントにメソッドを表記するのに好ましい方法は何ですか？

コメントするときに別の方法を参照することがあります。 PHPでここではいくつかの例： class A { /** * @see B::bar */ public function foo() { B::bar(); } } class B { public static function bar()

2熱

2答えて

作成またはレビューしたコードコメントの「禅」の瞬間は何ですか？

私は合理的に短いですが、かなり複雑なコードの例（オブジェクト、関数、クラス、特定の変数名のセットなど）を探しています。あなたが本当に誇りに思っているか、あなたが出会って「Aha！啓蒙の瞬間いくつかの潜在的な基準は、（すべてではないが、単一の例では満たす必要がある）：スパースと明らか自己を重視しました。文法や実装の詳細を理解していなくても、非プログラマであっても、あなたがやろうとしていること