0

我一直在使用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上搜索,但是我找不到任何其他發生此類情況的案例或者發生了什麼。

任何有關此事的幫助將不勝感激。

回答

0

儘管我在MSDN中沒有找到任何關於它的信息,但爲所有公開可見的(即publicprotected)元素生成文檔是有意義的。生成文檔的班級是public,而您遇到問題的班級是internal,因爲如果您未指定類別,這是類別的默認修飾符。

+0

謝謝,這個伎倆。我甚至沒有注意到這個班不公開。我對C#也很新,所以我忘了默認是'internal'。我很感激幫助。 – user3299958