Visual Studio 2012 XML注释尚未构建

问题描述:

我一直在使用Visual Studio 2012开发C#项目,并且一直在研究生成文档。大部分情况都很顺利,但由于某些原因,项目中的某些文件未包含在生成的.xml文档文件中。查看同一命名空间中的两个文件,或者完全相似,一个文件被记录,另一个不是。Visual Studio 2012 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文档注释,但是在构建之后,Amazon类会被记录并且Azure类不会。这两个文件都包含在项目中,并且位于相同的目录,名称空间等中。这些仅仅是示例,因为有很多文件正在被包含,许多文件不包含。

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

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

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

+0

谢谢,这个伎俩。我甚至没有注意到这个班不公开。我对C#也很新,所以我忘了默认是'internal'。我很感激帮助。 – user3299958