Tag: xml documentation

什么规则适用于SHFB的IntelliSenseComponent的输出文件夹？: 野田时间有一个问题反对它，它的XML文档文件包含所有的内部和私人成员也 – 这是一个耻辱。幸运的是， Sandcastle帮助文件生成器有一个自定义生成组件 – IntelliSenseComponent – 理论上完成正确的事情…。不幸的是，我无法弄清楚如何正确configuration它。文档给出了这个例子： <output includeNamespaces="false" namespacesFile="Namespaces" folder="{@OutputFolder}" /> 并指出：上面的例子是从Sandcastle帮助文件生成器的configuration文件中获取的。与它一起使用时，将使用replace标记{@SHFBFolder}和{@OutputFolder}将帮助文件构build器的文件夹和项目的输出文件夹插入到文件path中。这些在构build时被replace为适当的值。如果在您自己的构build脚本中使用该组件，请分别用相对或绝对pathreplace组件组件和输出文件夹的标签。那么，我正在使用SHFB，所以我期望这个工作。但是，除了绝对的工作path以外，我什么都得不到。我试过了： folder="." folder="{@OutputFolder}" folder="{@OutputFolder}XYZZY" folder="{@OutputFolder}\XYZZY" folder="{@OutputFolder}/XYZZY" folder="{@OutputFolder}/XYZZY/" （我只是使用XYZZY作为一个很容易search的东西。）看着源代码，我希望我可以使用一个环境variables，但是这不起作用： folder="%CD%\XYZZY" 虽然这样做… folder="%USERPROFILE%\XYZZY" 这工作： folder="c:\users\jon\test\xyzzy" …但我真的不想在那里有一个绝对的path名称。文件表明，所有这一切应该很容易…我错过了什么？涉及的版本： SHFB：1.9.3.0 沙堡：2.6.10621.1

Web Api的Xml文档如何包含主项目之外的文档？: 将XmlDoc集成到Web Api项目中的文档似乎只处理所有APItypes都是WebApi项目的一部分的情况。具体来说，它讨论了如何将XML文档重新路由到App_Data/XmlDocument.xml并取消注释将使用该文件的configuration文件中的行。这隐含地只允许一个项目的文档文件。但是，在我的设置中，我有我的请求和响应types在一个共同的“模型”项目中定义。这意味着如果我有一个定义的端点如： [Route("auth/openid/login")] public async Task<AuthenticationResponse> Login(OpenIdLoginRequest request) { … } 其中OpenIdLoginRequest在单独的C＃项目中定义如下： public class OpenIdLoginRequest { /// <summary> /// Represents the OpenId provider that authenticated the user. (ie Facebook, Google, etc.) /// </summary> [Required] public string Provider { get; set; } … } 尽pipe有XML文档，但查看特定于端点的帮助页面（例如http://localhost/Help/Api/POST-auth-openid-login ）时， request参数的属性不包含任何文档。我怎样才能使XML文档的子项目中的types出现在Web API XML文档中？