繁体   English   中英

尚未构建Visual Studio 2012 XML注释

[英]Visual Studio 2012 XML Comments not being built

我一直在使用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文档注释,但是在构建之后,会记录Amazon类,而Azure类则不会。 这两个文件都包含在项目中,并且位于同一目录,名称空间等中。这只是示例,因为其中包含许多文件,而许多文件没有。

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

在此问题上的任何帮助将不胜感激。

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

暂无
暂无

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM