c# - csharp classes "inherit"可以像java classes 那样的xml文档吗?

标签 c# java documentation

我正在为一些 csharp 代码添加注释,并且我正在使用 .net(或其他)提供的 xml 语言。我有一个接口(interface)和一些实现类。我在界面中有一个方法,它有一个评论。在实现类中没有对实现方法的评论。

当在 java 中这样做时,javadoc 在生成文档时会自动使用接口(interface)注释。然而,现在我构建了我的项目,我收到警告(从瑞典语翻译而来,抱歉)“缺少可见类型或成员 bla.blabla.blablabla() 的 xml 注释 (cs1591)”。这只是一个警告,还算不错。但!!!这意味着没有输出 xml 文件,所以我不能使用 sandcaSTLe 生成 chm 文档文件,这是我在这里的真正目标....谷歌搜索错误编码没有给出任何结果:(

我真的必须将方法注释复制到所有实现类吗?这就像......代码重复 D:没有办法获得 java 提供的行为吗?

最佳答案

我不知道有什么方法可以让它在 XML 文件生成时发生,但是 GhostDoc可能会让您免于手动执行复制。不过我不能说我自己用过它。

我同意这将是一个有值(value)的特性......特别是如果基类(或接口(interface))文档在派生类已实现和记录后发生更改。

关于c# - csharp classes "inherit"可以像java classes 那样的xml文档吗?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/4645923/

相关文章:

java - CircularLinkedList 删除方法不起作用

java - NoClassDefFoundError : org/apache/http/HttpEntity in Selenium for ChromeDriver?

api - 如何生成 Magento 的 API 文档/文档?

ruby-on-rails - 如何记录 Rails 模型中的隐式方法?

c# - 如何根据值列表选择行

c# - 如何在 XML 反序列化期间将 XML 字符串保留为字符串字段

c# - 在 C#.Net 中播放 MIDI 文件时听不到声音

c# - x.toString() 和 x +""之间的区别

javascript - 如何在 JSDoc 中引用仓库?

c# - dotnet.exe 已退出 - 访问冲突