0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

【C#】コード中のコメントに"。"をつけるかつけないか

Posted at

はじめに

今回は、コード中のコメントに "。" をつけるかつけないかを考えてみます。

/// <summary>
/// このメソッドは、何かを行います。
/// </summary>
void DoWork()
{
    // 内容は省略します。
}

結論はどちらでもよいが一貫性をもたせることです。

個人の好みの問題?

JavaScript の ";" よろしく、基本的に句読点はあってもなくてもいいと思います。句読点の歴史的にも読み手が読みやすくするための工夫で必須ではない、とかだったと思います。

つまるところ読みやすさを取るか、僅かなコード量の削減を取るかです。C# ではコメントアウトはコンパイル時に取り除かれるため、出力されるバイナリの大きさに影響しません(メタデータとかも残らない)。ソースコードのみ影響します。

ちなみに、自分は基本的につけません。コメントを区切りたくなったときは改行したりします。

void DoWork2()
{
    // コメントを区切りたい場合は
    // このように改行します
    // ちなみに // のあとに半角スペースを入れています
    // このほうが視認性がよさそうだからです
}

一貫性をもたせる

"。" をつけるつけないはリポジトリ作成時に選択し、その後は一貫性をもたせるのがいいと思います。

コンパイル結果に影響しないため混在しても問題はありませんが、コードを読む人の目線だと「なぜ混在しているのか」疑問に感じます。これの確認にリソースを割かないようにするためにも、一貫性をもたせるのがよさそうです。

きっと、足の裏についた米粒のように気になってリファクタしたくなるでしょう。

おわりに

なぜこんな話をしたかというと、自分もかつてコード中に "。" が混在してリファクタした経緯があったからです。

文字列リテラルにも似たようなことがいえるので、"。" をつけるかつけないかは一貫性をもたせるのがよさそうです。

0
0
2

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?