C# 命名ガイドラインによると、私のコードは次のようになりますPatient.Id
。Id
「Identity」の略なのでPascalケースです。ただし、英文では「ID」と書く必要があります。
これを XML コメントにどのように記述すればよいでしょうか?
The patient ID.
(「患者」は形容詞のように聞こえます。)The patient's ID.
(最も文法的に正しく、コメント セクションに適しているようにId
見えますが、代理キーであり、ビジネス ロジックの一部ではありません。エンド ユーザー ドキュメントのどこにも「ID」についての言及はありません。)The <c>Patient<c>'s ID
(私が作成しないと奇妙に聞こえますThe <c>Patient<c> object's ID.
が、どこにでも書くには長すぎます。)The <c>Patient<c>'s <c>Id</c>
Id
(は変数であり、 custom ではないため、技術的に間違っているように聞こえclass
ます。)