我今天第一次将 SandCaSTLe 与 HelpBuilder GUI 结合使用,以帮助创建一些我们公开的函数和属性的 API。我包括了/// <summary> ... </summary
我认为一些属性会从额外的文档或使用示例中受益。
当我将输出文件构建到 chm 时,我根本看不到摘要描述。列出了所有属性成员,但它们的描述是空白的。我重建了项目,并在 SandCaSTLe 中尝试了一些不同的设置,但它们仍然没有出现。
我忽略了一些明显的东西吗? SandCaSTLe 不读取属性摘要吗?还是摘要需要不同的关键字?
最佳答案
您必须告诉 Visual Studio 在编译时生成 XML 文档文件:只需按照此处所述设置相应的项目属性: http://msdn.microsoft.com/en-us/library/vstudio/x4sa0ak0(v=vs.100).aspx
之后,SandcaSTLe会在“描述”栏中输出“摘要”注释。
关于c# - SandcaSTLe 没有记录属性摘要,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/10938977/