为了在XML注释/文档中引用类的成员，您必须使用以下标记:更好解释here.如何引用索引器？我的意思是，像这样的成员:internalobjectthis[intindex]{...}提前致谢。 最佳答案 关于c#-如何在C#注释中引用类的索引器成员，我们在StackOverflow上找到一个类似的问题： https://stackoverflow.com/questions/341118/
这个问题在这里已经有了答案:HowdoIexportthecodedocumentationinC#/VisualStudio2008?(7个答案)关闭8年前。我为我的代码写了一些注释。现在如何使用VisualStudio2010生成文档或类似的东西？
关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题？更新问题，以便editingthispost可以用事实和引用来回答它.关闭4年前。Improvethisquestion我对应该在哪里应用我的XML注释感兴趣。我是否应该在接口(interface)中放置一个更通用的XML注释，而在实现类中放置一个更具描述性的注释？像这样:publicinterfaceIObjectRepository{//////ReturnsanobjectfromtherespositorythatcontainsthespecifiedID.///ObjectGetObject(i
带有XML文档的示例方法://summaryandparamtagsareherewhenyou'renotlooking.//////isnull.///publicvoidWrite(stringtext){if(text==null)thrownewArgumentNullException("text","Textmustnotbenull.");//syncstuff...}Write(null)按预期抛出异常。这是一个异步方法:publicasyncTaskWriteAsync(stringtext){if(text==null)thrownewArgumentNullEx
关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题？更新问题，以便editingthispost可以用事实和引用来回答它.关闭4年前。Improvethisquestion我正在用注释装饰我的C#代码，这样我就可以生成HTML帮助文件。我经常声明和记录接口(interface)。但是实现这些接口(interface)的类可能会抛出特定的异常，具体取决于实现。有时，客户只知道他正在使用的接口(interface)。我是否应该通过添加可能由其实现者抛出的异常来记录我的接口(interface)？我是否应该创建/记录自定义异常，以便接口(interface)实现者
我为什么要使用像这样的代码契约Contract.Requires(x!=null,"x");而不是旧的if(x!=null){}elsethrow...除了简洁还有其他好处吗？ 最佳答案 根据MSDN:Thebenefitsofcodecontractsincludethefollowing:Improvedtesting:Codecontractsprovidestaticcontractverification,runtimechecking,anddocumentationgeneration.Automatictesting
关闭。这个问题不符合StackOverflowguidelines.它目前不接受答案。我们不允许提问寻求书籍、工具、软件库等的推荐。您可以编辑问题，以便用事实和引用来回答。关闭4年前。Improvethisquestion我正在使用Doxygen为我们的API生成用C#编写的文档。但是，它公开了私有(private)/protected成员。有没有办法隐藏这些？我想出了如何隐藏文件:EXCLUDE=文件名列表然而，我需要更多的粒度，从而使用户免受不必要的API干扰。示例Doxygen文件以及提示/技巧将不胜感激。您使用什么工具从源代码生成API？当我通过C++在C#中使用Doxygen
我想记录枚举类型字段的默认值://////Thedefaultvalueis.///publicOrientationBoxOrientation;编译器警告它无法解析引用。前缀F:或M:会使编译器静音，但E:也会静音，所以我不确定哪个前缀是正确的。 最佳答案 前缀F、M和E都是有效的，可能是编译器警告消失的原因。不过，您应该使用引用字段的F。有关VisualStudio如何生成文档标识符的更多信息，请参阅:ProcessingtheXMLFile(C#ProgrammingGuide)
我一直在网上查找如何在C#控制台应用程序中使用“javadoc”。在这种情况下，所有文章都引用了C#的Web表单，///将是javadoc。如果您在visualstudio中制作控制台应用程序，该怎么做？编辑:我记得它必须在方法之前处理一个@ 最佳答案 三个正斜杠开始文档://////Mymethoddoesstuff.///publicvoidMyMethod(){...}然后，您可以修改项目属性以输出包含其他开发人员文档的XML文件，或使用类似SandCastle的应用程序生成完整的文档网页。
关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题？更新问题，以便editingthispost可以用事实和引用来回答它.关闭5年前。Improvethisquestion早上好、下午好、晚上好或晚上好(取决于您所在的时区)。这只是关于C#中XML注释的一般问题。我从来没有大肆评论我的程序，我一直都是一个冗长的变量/属性/方法命名者，让代码自己说话。如果我正在编写一些相当困惑的代码，我确实会写评论，但在大多数情况下，我不会写很多评论。我正在阅读有关.NET、SandcaSTLe和codeplex上的帮助文件生成器中的XML注释的一些资料，它让我走上了想要记录
