【问题标题】:Visual Studio 2012 XML Comments not being built未构建 Visual Studio 2012 XML 注释
【发布时间】:2014-02-12 05:42:19
【问题描述】:

我一直在使用 Visual Studio 2012 处理 C# 项目,并且一直在研究生成文档。大多数情况下一切顺利,但由于某种原因,项目中的某些文件未包含在生成的 .xml 文档文件中。查看同一命名空间中的两个文件,其他方面完全相似,一个正在记录,另一个没有。

一类:

namespace testingGui.Utilities
{
    /// <summary>
    /// AmazonApi summary
    /// </summary>
    public class AmazonApiCalls
    {
        /// <summary>
        /// Constructor for the Amazon class
        /// </summary>
        /// <param name="name">User name</param>
        /// <param name="pass">Password</param>
        public AmazonApiCalls(string name, string pass)
        {
            //code
        }
//etc.

还有其他类:

namespace testingGui.Utilities
{
    /// <summary>
    /// Azure_Api summary
    /// </summary>
    static class Azure_API
    {
        /// <summary>
        /// Azure_Api's authentication function
        /// </summary>
        /// <param name="username">username</param>
        /// <param name="password">password</param>
        public static string authenticateSession(string username, string password)
        {
//etc.

(项目涉及到使用各种云服务提供商,这两个提供商的具体功能在对应的类中)。

它们都有用于所有功能的 xml 文档 cmets,但是在构建之后,Amazon 类得到了文档化,而 Azure 类没有。这两个文件都包含在项目中,并且位于相同的目录、命名空间等中。这些只是示例,因为包含许多文件,也有许多不包含。

我能想到的唯一原因是 Azure 文件(和其他文件)可能是在项目之外创建然后导入的(我没有参与该部分,所以我不确定),但我不明白为什么会出现问题,因为它们包含在项目中。我查看了msdn 文档并在 Google 上进行了搜索,但我找不到任何其他发生这种情况的案例或如果发生这种情况该怎么办。

我们将不胜感激任何有关此事的帮助。

【问题讨论】:

    标签: c# visual-studio visual-studio-2012 documentation documentation-generation


    【解决方案1】:

    虽然我在 MSDN 中没有找到任何关于它的信息,但为所有公开可见的(即 publicprotected)元素生成文档是有意义的。您生成文档的类是public,而您遇到问题的类是internal,因为如果您不指定,这是类的默认修饰符。

    【讨论】:

    • 谢谢,成功了。我什至没有注意到这门课不是公开的。我对 C# 也很陌生,所以我忘记了默认值是“内部”。感谢您的帮助。
    猜你喜欢
    • 1970-01-01
    • 2021-08-20
    • 1970-01-01
    • 2012-08-29
    • 2012-10-24
    • 1970-01-01
    • 1970-01-01
    • 2012-10-18
    • 1970-01-01
    相关资源
    最近更新 更多