タグ付けされた質問 「comments」

コメントは、コンパイルされていない、プログラマが読み取り可能な注釈をコンピュータプログラムのソースコードに埋め込むために使用されるプログラミング言語の構成要素です。

14
シンプルなゲッター/セッターコメント
ゲッターとセッターにコメントするためにどの規則を使用していますか？これは私がかなり長い間疑問に思っていたものです。例えば： /** * (1a) what do you put here? * @param salary (1b) what do you put here? */ public void setSalary(float salary); /* * (2a) what do you put here? * @return (2b) */ public float getSalary(); 1a / bと2a / bでまったく同じものを書いていることにいつも気づきます。1a）従業員の給与を設定します。1b）従業員の給与を設定します。それはとても冗長なようです。今私はあなたがコンテキストを与えるためにあなたが（a）の部分でより多く書くかもしれないもっと複雑な何かを見ることができました、しかしそこにいるゲッター/セッターの大部分にとって言葉遣いはほとんど正確に同じです。 単純なゲッター/セッターについて、（a）部分または（b）部分のいずれかのみを入力してもよいかどうか、私は興味があります。 どう思いますか？
4
PHP関数のコメント
簡単な質問：一部のPHP関数は、私には知られていない形式を使用して上部にコメントされているのを見てきました。 /** * * Convert an object to an array * * @param object $object The object to convert * @return array * */ 私のIDEでは、@ paramや@returnなどをドロップダウンで選択できるため、どこかに文書化する必要があります。私はグーグルを検索してみましたが、検索に@記号が含まれません。 このコメント形式とは何ですか？また、それに関する情報はどこにありますか？
10
複数行コメントの回避策？
私は（ある程度）すでにこの質問に対する答えを知っています。しかし、私はそれがRユーザーリストで頻繁に尋ねられるものであると考え、1つの確かな良い答えがあるはずです。 私の知る限りでは、Rには複数行のコメント機能はありません。では、誰かに良い回避策はありますか？ Rでのかなりの作業は通常、インタラクティブセッション（複数行コメントの必要性に疑問を投げかける）を伴いますが、同僚やクラスメートにスクリプトを送信しなければならない場合があります。そして、他の言語から来る人々にとって、それはかなり自然な質問です。 過去には、引用符を使用しました。文字列は改行をサポートするため、Rスクリプトを実行して " Here's my multiline comment. " a <- 10 rocknroll.lm <- lm(blah blah blah) ... 正常に動作します。誰かがより良い解決策を持っていますか？
108 r  comments  r-faq 
7
DOSバッチファイルの複数の行にコメントを付ける
巨大なMS DOSバッチファイルを作成しました。このバッチファイルをテストするには、いくつかの行のみを実行する必要があり、残りの行を非表示/コメントアウトします。 私はいくつかの既存のコメント行で始まる::ので、::すべてのコメントをスクランブルするため、これ以上使用できません。 この問題を解決するにはどうすればよいですか？
8
内部ライブラリのdoxygenコメントブロックを配置する場所-HまたはCPPファイル内？[閉まっている]
休業。この質問は意見に基づいています。現在、回答を受け付けていません。 この質問を改善してみませんか？この投稿を編集して質問を更新し、事実と引用で回答できるようにします。 2年前休業。 この質問を改善する 常識では、Doxygenコメントブロックは、クラス、構造体、列挙型、関数、宣言があるヘッダーファイルに配置する必要があります。これは、ソースなしで配布されることを意図したライブラリ（ヘッダーとオブジェクトコード付きのlibのみ）の健全な議論であることに同意します。 しかし...私は、会社の内部（または私自身のサイドプロジェクト）のライブラリを開発するときに、その完全なソースコードで使用される、まったく逆のアプローチを考えていました。私が提案するのは、ヘッダーで宣言されたクラスと関数のインターフェースを混乱させないために、実装ファイル（HPP、INL、CPPなど）に大きなコメントブロックを配置することです。 長所： ヘッダーファイルの乱雑さが減り、追加できるのは関数の分類のみです。 たとえばIntellisenseが使用されるときにプレビューされるコメントブロックは衝突しません-これは、.Hファイルに関数のコメントブロックがあり、同じ.Hファイルにそのインライン定義がある場合に観察された欠陥です。 .INLファイルから含まれています。 短所： （明白なもの）コメントブロックは、宣言があるヘッダーファイルにはありません。 それで、あなたは何を考え、そしておそらく提案しますか？
10
ネストされたHTMLコメントは可能ですか？
タイトル通り; 有効なHTMLにネストされたコメントを含めることは可能ですか？以下の例を参照してください... <p>some text</p> <!-- comment 1 <p>commented out html</p> <!-- comment 2 // are nested html comment allowed? end of comment 2 --> <p>more commented out html</p> end of comment 1 --> <p>some more text</p> それはそうではないようです、ネストされたコメントを機能させる方法を誰かが知っていますか？
15
コメントするXcodeコマンドスラッシュショートカットが時々しか機能しない
キーボードショートカットを使用してコメントを付けたり、コード⌘+のコメントを外したりすると、Xcodeの信頼性が非常に低下します/。いつ壊れるのか本当のパターンを見つけることができないようですが、通常、シミュレータでコードをビルドして実行した後に発生します。コードファイルのいずれかで何かを編集するまで、それは再び機能しません。メインビューで別のファイルに切り替えても、ショートカットによるコメントは機能しません。インデント⌘+ などの他のキーボードショートカットは[引き続き正常に機能します。 他の人がこの問題を抱えていますか？そうであれば、解決策を見つけましたか？私はそれが小さな不満のように思えることを知っていますが、実行してからすぐにコードのブロックをコメントアウトして効果を確認しようとすると、それは少し不便です。 OXS Yosemite 10.10（14A389）でXcode 6.1（6A1052d）を使用しており、重要な場合はiOS用Objective-Cで開発しています。
9
C＃のコメント継承（実際には任意の言語）
このインターフェイスがあるとしましょう public interface IFoo { ///<summary> /// Foo method ///</summary> void Foo(); ///<summary> /// Bar method ///</summary> void Bar(); ///<summary> /// Situation normal ///</summary> void Snafu(); } そしてこのクラス public class Foo : IFoo { public void Foo() { ... } public void Bar() { ... } public void Snafu() { …
10
Notepad ++のコメントコード
Pythonでプログラムを作成するためのエディターとしてNotepad ++を使用しています。ふざけているように聞こえるかもしれませんが、エディタ内を見回したところ、コードでブロックコメントを実行する手段（手動の方法ではなく、Emacsのようなもの）が見つかりませんでした。 Notepad ++では非常に多くの言語設定がサポートされているため、コメントコードをブロックする方法を探しています。
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.