根据C#命名指南,我的代码如下所示:Patient.Id
。 Id
属于Pascal案例,因为它是" Identity"的缩写。但是在英文句子中,它应该写成" ID"。
我如何在我的XML评论中写这个?
The patient ID.
(听起来像#34;患者"是形容词。)
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
是变量而不是自定义class
,因此技术上出现了问题。)