Sandcastle不呈现返回类型？ [英] Sandcastle not rendering return type?

问题描述

我有一个包含几个类的程序集和一个带有几个方法的接口

Well i have a assembly with a few classes in and a interface with a few methods

现在当我在这个程序集上运行SandCastle时，它会生成一个类似于它的文档但是如果我去接口上的方法它不会像参数那样记录返回类型..

Now when i run SandCastle on this assembly it generates a documentation like it should but if i go to a method on the interface it does not document the return type the way it does with the parameters..

我的猜测是样式文件或某些东西有问题但是我不知道要编辑什么文件，所以我缺少什么？

My guess is that some thing is wrong in a style file or some thing but i have no idea what file to edit so what am i missing?

• Sandcastle帮助文件生成器实用程序，版本1.9.3.0
• Sandcastle-June 2010发布（版本2.6.1062.1）
• Sandcastle样式2010年6月（2.6.10621.1） - Rev 1

我正在使用vs2005 style

Im using the vs2005 style

推荐答案

确保你添加了< returns>元素，用于记录方法的返回值。 如果有，请检查XML注释文件以确保它也在那里。 如果没有，您可能需要重建项目以获得最多
日期的评论文件。 这是缺少文档的两个典型问题。

Make sure you've added a <returns> element to document the return value for the method.  If you have, check the XML comments file to make sure it's in there too.  If not, you may need to rebuild your project to get the comments file up to date.  Those are the two typical issues with missing documentation.

Eric

 

这篇关于Sandcastle不呈现返回类型？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！