3

私は、Java での適切なコードの書式設定、規則、きちんとした状態を保ち、適切なコメントを付けることを学ぼうとしています。

しかし、ユーザー指定の値を「受け取る」ために JOptionPane 入力ダイアログを呼び出すときに、どのような言葉遣いを使用すればよいかについて、私は困惑しています。

この状況で通常使用されるものは何ですか?

「// Get user input」を使用していますが、何かを「取得」することにはまったく別の意味があることを説明する記事を読みました。

4

2 に答える 2

8

私の意見では、コメントはあなたが何かをする理由を説明するべきです（それが明らかでない場合）。コード自体は、それがどのように行われるかを示す必要があります。

  • コードが何をするのか理解できない場合、コードが悪い可能性があります。
  • コードを理解しているが、特定のアクションが実行される理由を理解していない場合は、コメントがありません。

したがって、コメントを追加する代わりに// read user input、便利な方法でメソッドと変数に名前を付ける必要があります。

...
String userInput = getUserInput(); 
...

これを理解するのにコメントは必要ありません。

于 2013-09-20T21:47:30.040 に答える
3

コメントの正確な言語についてあまり強調しないでください。コードを維持するためにあなたの後ろに来る人が何が起こっているのかを理解できるように、それらを明確にしたいだけです。コメントの構文について心配する必要はありません。実際にはそれほど重要ではありません。

あなたは言えた：

//get user input
//read user input
//take user input

正直なところ、これは心配する必要のない最も重要なことの 1 つです。あなたがしていることを人々が知っていることを確認してください。コメントではなく、コード自体をクリーンで適切にフォーマットすることに重点を置いています。ほとんどのプログラマーはコメントを書くのに時間をかけないので、コメントを持つことは重要ですが、それは最も重要なことではありません。

メソッド/クラス/関数/変数に名前を付けるときは、言葉遣いに注意することがより重要です。コメントではありません。

:)

于 2013-09-20T21:40:28.600 に答える