根据 C# 命名指南,我的代码如下所示Patient.Id
:Id
是帕斯卡案例,因为它是“身份”的缩写。但是在英文句子中,它应该写成“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
它是一个变量而不是一个自定义class
。)