C＃中XML文档通用属性的推荐格式

Question

XML文档的正确格式是什么？C＃/ VisualStudio中MyClass的ShoeRun字段属性

MyClass
{
private IMyRunHelp<MyShoeClass> ShoeRun;
}

Answer 1

答案可能是基于意见的。这取决于

• 贵公司的编码指南
• 项目的编码指南（有时会覆盖公司设置）
• 该领域的复杂性。
  • 如果它很简单，也许根本不需要文档。
  • 如果它＆＃34;正常＆＃34;，//可能就够了
  • 如果它很复杂，可能/// <summary>样式会更好。
  • 如果您有疑问，请在您的团队中进行讨论。