氧样式的文档注释在c#中是禁止的吗?



我有一个项目,我记录(在源代码中)基本上是一个事后的想法。这不是一个大项目,只有我使用它(我知道),所以这不是一个大问题。我之所以使用oxygen,是因为我希望我的所有文档都能够导出为HTML。我的问题是我使用了氧样式注释,而不是标准的XML样式注释(我不喜欢它,但无论如何)。

现在我正在考虑尝试出售这段代码,在我尝试之前,我想确保它的质量好。我看到的问题与氧风格的评论是,他们没有得到智能感知支持。除此之外,非xml注释在c#中是禁止的吗?在Visual Studio中有什么选项可以设置来获得智能感知支持吗?

如果需要智能感知,则必须使用XML注释。Visual c#编译器不能识别或理解oxygen.

如果您想使用XML注释来生成HTML文档,请使用Sandcastle——这就是它的作用。

查看我的文档插件,AtomineerUtils。

它可以读取氧注释并将其转换为XML文档格式。它将在一次传递中处理整个作用域块,因此可以用来快速将遗留文档转换为不同的格式。

它也是非常可配置的,因此您可以调整输出以使其尽可能可读。

相关内容

  • 没有找到相关文章

最新更新