我正在使用最新版本的Sandcastle生成文档。我有一些公共和私人方法和领域的公共实例类。公共方法在Sandcastle的最终文档输出中生成,但不会生成其他成员。在可见性下,我已经检查了所有内容,所以我希望所有内容都应该在文档中生成。Sandcastle不生成私有方法文档(C#)
任何人有任何想法?
我正在使用最新版本的Sandcastle生成文档。我有一些公共和私人方法和领域的公共实例类。公共方法在Sandcastle的最终文档输出中生成,但不会生成其他成员。在可见性下,我已经检查了所有内容,所以我希望所有内容都应该在文档中生成。Sandcastle不生成私有方法文档(C#)
任何人有任何想法?
由于从埃里克·伍德拉夫(沙堡帮助文件生成器的开发者)官方FAQ
类需要在代码中声明为public,则需要启用 的DocumentPrivates和/或DocumentInternals项目属性,以便Sandcastle记录内部/私人成员,或者您需要至少包含一个程序集和至少一个要记录的命名空间。
是的,这是我所拥有的,公开课和我已启用显示私有:) – user1013388
为什么要为私有方法生成API文档?它们是实现细节,因此不应以代码本身之外的任何形式出现。 –
因为这是内部文档,人们想知道胆子里发生了什么。 – user1013388
然后他们应该阅读代码。期待他们从代码中查看注释,以确定代码的功能是疯狂。 –