NRefactory在代码

Question

我想获取与使用NRefactory的方法关联的xml文档。通过使用我在answer

中找到的以下代码，我弄湿了脚

var parser = new CSharpParser();
SyntaxTree tree = parser.Parse(code, "test.cs");

CSharpUnresolvedFile file = tree.ToTypeSystem();
foreach (IUnresolvedTypeDefinition type in file.TopLevelTypeDefinitions) {
    foreach (IUnresolvedMethod method in type.Methods) {
        Console.WriteLine(method.Name);
    }
}

但是，我正在查看IUnresolvedTypeDefinition接口，它没有任何“Comments”属性。此外，IUnresolvedMethod接口没有任何“Comments”属性。我知道可以检索注释，因为我这样做是通过使用与找到的CodeProject文章相关联的WinForms应用程序here

演示的作者不使用“ToTypeSystem（）”方法。相反，他穿越树。以下是他所做的一些片段：

SyntaxTree tree = parser.Parse(line, "demo.cs");

                    foreach (var element in tree.Children)
                    {
                        MakeTreeNode(element);
                    }


static void MakeTreeNode(AstNode node)
    {
        Console.WriteLine(GetNodeTitle(node));
        foreach (AstNode child in node.Children)
        {
            MakeTreeNode(child);
        }
    }

    static string GetNodeTitle(AstNode node)
    {
        StringBuilder b = new StringBuilder();
        b.Append(node.Role.ToString());
        b.Append(": ");
        b.Append(node.GetType().Name);
        bool hasProperties = false;
        foreach (PropertyInfo p in node.GetType().GetProperties(BindingFlags.Public | BindingFlags.Instance))
        {
            if (p.Name == "NodeType" || p.Name == "IsNull" || p.Name == "IsFrozen" || p.Name == "HasChildren")
                continue;
            if (p.PropertyType == typeof(string) || p.PropertyType.IsEnum || p.PropertyType == typeof(bool))
            {
                if (!hasProperties)
                {
                    hasProperties = true;
                    b.Append(" (");
                }
                else
                {
                    b.Append(", ");
                }
                b.Append(p.Name);
                b.Append(" = ");
                try
                {
                    object val = p.GetValue(node, null);
                    b.Append(val != null ? val.ToString() : "**null**");
                }
                catch (TargetInvocationException ex)
                {
                    b.Append("**" + ex.InnerException.GetType().Name + "**");
                }
            }
        }
        if (hasProperties)
            b.Append(")");
        return b.ToString() + "\n";
    }

我想知道NRefactory API中是否有一个方法可以获得与C＃代码段中的方法相关联的文档。

Answer 1

我找到了一个方法，可以获得与NRefactory API中的方法相关联的文档。它是“GetDocumentation”方法，它有两个重载

• DocumentationComment GetDocumentation（IEntity实体）;
• DocumentationComment GetDocumentation（IUnresolvedEntity实体，IEntity resolvedEntity）;

以下是使用示例

                SyntaxTree tree = parser.Parse(line, "demo.cs");

                var testClass = tree.Descendants.OfType<TypeDeclaration>().Single(x => x.Members == Method);
                var testClassAttributes = testClass.Attributes.SelectMany(x => x.Attributes).ToArray();

                List<Dictionary<string, object>> myList = new List<Dictionary<string, object>>();

                string nombreControlador = null;
                string rutaControlador = null;
                string actionKeyPath = null;
                string fullControllerPath = null;
                int counter = 0;

                CSharpUnresolvedFile file = tree.ToTypeSystem();



                foreach (IUnresolvedTypeDefinition type in file.TopLevelTypeDefinitions)
                {
                    nombreControlador = type.Name;
                    actionKeyPath = type.Fields.Skip(1).FirstOrDefault().ConstantValue.ToString();
                    fullControllerPath = type.Fields.First().ConstantValue.ToString();
                    rutaControlador = type.FullName;
                    foreach (IUnresolvedMethod method in type.Methods)
                    {
                        string documentation = file.GetDocumentation(method).Trim();

                        XDocument doc = XDocument.Parse("<documentation>" + documentation + "</documentation>");        
                        Dictionary<string, object> myDic = new Dictionary<string, object>();
                        Console.WriteLine(method.Name);
                        myDic.Add("MethodSignature", method.Name);
                        myDic.Add("MethodDescription", doc.Descendants().Select(e => (string)e.Element("summary")).FirstOrDefault());
                        myDic.Add("ActionKeyPath", actionKeyPath == null? "" : actionKeyPath);
                        myDic.Add("Counter", ++counter);
                        myDic.Add("FullControllerPath", fullControllerPath == null? "" : fullControllerPath);
                        myDic.Add("Route", method.Attributes == null ? "" : method.Attributes.Count <= 1 || method.Attributes.Skip(1) == null? "" : method.Attributes.SelectMany(a => a.);
                        myDic.Add("Verb", "");
                        myDic.Add("Input", "");
                        myDic.Add("Output", "");
                        myList.Add(myDic);
                    }
                }

顺便说一下，我正在使用5.0版本的NRefactorize。我记得在某处读过版本5.0包含抽象语法树

中的注释