C# と VB.NET の質問掲示板

ASP.NET、C++/CLI、Java 何でもどうぞ

C# と VB.NET の入門サイト

Re[2]: IsHogeプロパティのコメントの書き方


(過去ログ 129 を表示中)
掲示板トップ C# と VB.NET 入門 新規作成 利用方法/規約 トピック表示 ランキング 記事検索 過去ログ

[トピック内 5 記事 (1 - 5 表示)]　 << 0 >>

■76593 / inTopicNo.1) 　IsHogeプロパティのコメントの書き方
  ▼■
□投稿者/ nobb (82回)-(2015/07/27(Mon) 10:46:12)

分類:[.NET 全般]　

現在作っているソフトでIsから始まるbool値のプロパティに付けるコメントで悩んでいます。
今は「○○をするかを表すbool値を取得または、設定します。」という形ですが、bool値はコメントに無くてもわかるし、
かといって「○○をするかを表すbool値を...」だと(自分的に)モヤモヤして気持ち悪いんです。

そこでMSDNの中でIs○○の形になっているプロパティのコメントを参考にしたいのですが、
Is○○というプロパティが思いつきません。

いくつか見て回りたいので、Is○○プロパティをお教え下さい。
引用返信 編集キー/
■76595 / inTopicNo.2) 　Re[1]: IsHogeプロパティのコメントの書き方
▲▼■
□投稿者/ 774RR (279回)-(2015/07/27(Mon) 10:58:50)
一般論として Is の後ろは名詞ではなくて動詞（それも過去分詞）なほうが英語流だと思う。ないしは形容詞。
〜済み　とか
〜可能　とか

System.Windows.Forms.Controls だと
https://msdn.microsoft.com/ja-jp/library/System.Windows.Forms.Control.aspx

IsAccessible IsDisposed IsHandleCreated IsMirrored
あたりが存在するようだ

そのプロパティの命名に Is が必要かどうかあたりから考察したほうがよさそうな気がする。
名詞ならそのままプロパティ命名すればいいんぢゃないかな。
引用返信 編集キー/
■76597 / inTopicNo.3) 　Re[1]: IsHogeプロパティのコメントの書き方
▲▼■
□投稿者/ しゃむこ (11回)-(2015/07/27(Mon) 11:21:09)
ぱっとでてきたのはToolBarのIsLockedプロパティ、
あとReadOnlyですがType.Is****で一杯ある気がします。Type.IsArrayとか。
MSDN見たところ「Type が配列かどうかを示す値を取得します。」とありますね。

私の周囲では割と「○○ならばT、○○でなければ（××ならば）F」とズバっと書いてしまっています。
ただReadOnlyかどうかをコメントに反映するなら、「取得」or「取得または設定」という文言は必須かも、、と、この記事を読んでいて思いました。

■No76593 (nobb さん) に返信
> 現在作っているソフトでIsから始まるbool値のプロパティに付けるコメントで悩んでいます。
> 今は「○○をするかを表すbool値を取得または、設定します。」という形ですが、bool値はコメントに無くてもわかるし、
> かといって「○○をするかを表すbool値を...」だと(自分的に)モヤモヤして気持ち悪いんです。
>
> そこでMSDNの中でIs○○の形になっているプロパティのコメントを参考にしたいのですが、
> Is○○というプロパティが思いつきません。
>
> いくつか見て回りたいので、Is○○プロパティをお教え下さい。
引用返信 編集キー/
■76599 / inTopicNo.4) 　Re[2]: IsHogeプロパティのコメントの書き方
▲▼■
□投稿者/ nobb (83回)-(2015/07/27(Mon) 11:43:43)
■No76595 (774RR さん) に返信
ご回答ありがとうございます。

> 一般論として Is の後ろは名詞ではなくて動詞（それも過去分詞）なほうが英語流だと思う。ないしは形容詞。
> 〜済み　とか
> 〜可能　とか
これに関しては私の例としてあげたものが適当すぎました。申し訳ありません。
100%そうなっているという自信は(乏しい英語力ゆえ)ないものの、そのように命名する意識はもっています。


> System.Windows.Forms.Controls だと
> https://msdn.microsoft.com/ja-jp/library/System.Windows.Forms.Control.aspx
>
> IsAccessible IsDisposed IsHandleCreated IsMirrored
> あたりが存在するようだ
ご提示ありがとうございます。
「○○されているかどうかを示す値を取得します。」という形がMSDN的なのか。。。
あくまで自分的にモヤモヤしてしまうものの、このように倣っていきます。
引用返信 編集キー/
■76600 / inTopicNo.5) 　Re[2]: IsHogeプロパティのコメントの書き方
▲▼■
□投稿者/ nobb (84回)-(2015/07/27(Mon) 11:51:15)
■No76597 (しゃむこ さん) に返信
ご回答ありがとうございます。
774RRさんへの返信と重複してしまいますが、「○○かどうかを示す値を取得(または、設定します)」という言い回しがいいようですね。

> 私の周囲では割と「○○ならばT、○○でなければ（××ならば）F」とズバっと書いてしまっています。
> ただReadOnlyかどうかをコメントに反映するなら、「取得」or「取得または設定」という文言は必須かも、、と、この記事を読んでいて思いました。
ズバっとタイプのコメントも好きなんですが、ReadOnlyかどうかを判断できないので「取得」or「取得または設定」も付けると
長くてうっとうしくなるなぁ、でも好きなんだけどなぁ、、、という所で悩ましいです。
ので！MSDNを理由に自分を言い聞かせます！
解決済み
引用返信 編集キー/


トピック内ページ移動 / << 0 >>

このトピックに書きこむ

過去ログには書き込み不可

管理者用

- Child Tree -