我正在开发一个web服务,以发布给不同的用户消费。
为了让他们的工作更流畅,我想记录我所有的web方法,以及它们的输入/输出对象,就像下面的图片一样(这是我在web上看到的一个示例)。
我只是尝试使用WebMethodAttribute来装饰我的方法,但我唯一实现的是方法描述。
我尝试使用WCFExtras,但不适合我的项目,因为它不是WCF服务:/
我问:有没有什么工具可以做这样的工作?有谁知道要使用的.NET属性或框架吗?
发布于 2011-07-14 05:37:57
我对Sandcastle和标准C# XML Documentation的结合很满意。
基本上,您可以像往常一样对方法进行注释(在类型或方法名之前输入///
以生成注释框架)。然后,在项目上启用enable XML documentation output。最后,使用工具(例如Sandcastle)使用生成的XML文件来构建帮助文件/网站。
在Sandcastle的例子中,它生成一个CHM。我个人喜欢以CHM文件的形式查看API。还有其他工具可以使其成为Web站点。
https://stackoverflow.com/questions/6685754
复制相似问题