.NET中的XML代码注释

您在代码文件中使用了多少 XML注释,以及如何使用它们？我已经看到您可以使用它们来生成XML文档,但是这些XML文档是否可以用于为您的代码生成HTML帮助文件或模式文件？

此外,您是否使用过任何自动生成的评论工具(即GhostDoc),您的印象是什么？

思考？

如果从构建中分发XML文件以及DLL,那么XML文档本身就很有用.这样,API的任何消费者都可以从IDE中获得有用的信息(通过Intellisense或对象浏览器).

现在,XML注释的最大用途是从这些构建的XML文件生成帮助文档.目前Microsoft Sandcastle是关于此的方法.它可以生成HTML帮助1(即CHM)文件或HTML帮助2(即可以集成到Visual Studio帮助中的帮助文件). (注意：在过去,NDoc的选项似乎更具吸引力 – 有些人仍然使用它 – 但Sandcastle目前似乎是官方和推荐的方法,特别是考虑到它相当稳定和完全足够几乎任何目的.)请参阅SandcastleDocs网站开始(这是微软的一位开发人员非正式地把它放在一起我相信).特别是,您需要查看Sandcastle Help File Builder GUI – 根据我的经验,我发现它是一个很好的工具.