注释中代码引用的大写约定

时间:2013-06-28 11:20:48

标签: c# .net comments naming-conventions naming

根据C#命名指南,我的代码如下所示:Patient.IdId属于Pascal案例,因为它是" Identity"的缩写。但是在英文句子中,它应该写成" ID"。

我如何在我的XML评论中写这个?

  1. The patient ID.(听起来像#34;患者"是形容词。)

  2. The patient's ID.(似乎语法最正确且适合评论部分,但Id是代理键,而不是业务逻辑的一部分。最终用户文档中没有位置有提及" ID"。)

  3. The <c>Patient<c>&apos;s ID(听起来很奇怪,除非我这样做The <c>Patient<c> object's ID.但是到处写的时间太长了。)

  4. The <c>Patient<c>&apos;s <c>Id</c>(由于Id是变量而不是自定义class,因此技术上出现了问题。)

0 个答案:

没有答案