如何通过namespaceDoc类文件为C#命名空间的<summary>添加注释(不使用SHFB)

Question

我想向C#名称空间添加注释(我不想使用sandcastle)。我已经将空的NamespaceDoc类文件添加到我的项目中。

///<summary>
/// These are some the namespace comments 
///</summary>
[System.Runtime.CompilerServices.CompilerGeneratedAttribute()]
class NamespaceDoc {
}

当我构建项目时，xml文档以预期的格式出现。

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>MyNamespaceName</name>
    </assembly>
    <members>
        <member name="T:MyNamespaceName.NamespaceDoc">
            <summary>
             These are some the namespace comments 
            </summary>
        </member>        
    </members>
</doc>

但我想要写的实用程序将执行以下操作:在构建过程中，如果类文件NamespaceDoc的注释在<summary>中，xml文档文件应采用以下格式:类NamespaceDoc的<summary>将移动到名称空间<summary>，而NamespaceDoc将从xml文档中消失。以下是所需的格式。

?xml version="1.0" encoding="utf-8"?>
<doc>
  <assembly>
    <name>MyNamespaceName</name>
  </assembly>
  <members>
    <member name="N:MyNamespaceName">
      <summary>
             These are some namespace comments
      </summary>
    </member>
  </members>
</doc>

你能帮我写这样的工具吗？谢谢。

Answer 1

我认为在构建过程中很难更改xml。因此，我建议您可以使用c#代码来修改代码。

下面是一个代码示例。

    var doc = XDocument.Load("Mynamespace.xml");
    var result = doc.Descendants("member");
    foreach (var item in result)
    {
        if(item.Attribute("name").Value== "T:Mynamespace.NamespaceDoc")
        {
            item.Attribute("name").Value= item.Attribute("name").Value.Replace(".NamespaceDoc", " ");
        }

    }
    doc.Save("Mynamespace.xml");