Question

我正在研究Visual Studio可扩展性。来自 MSDN 的代码创建了一个新的C＃解决方案，其中包含一个带有类的项目：

EnvDTE.DTE dte =   this.GetService(typeof(Microsoft.VisualStudio.Shell.Interop.SDTE)) as EnvDTE.DTE;
EnvDTE80.Solution2 solution = (EnvDTE80.Solution2)dte.Solution;
try {
    solution.Create(@"F:\Dev\Visual Studio 2013\Packages\Spikes\VSPNewSolution\Test\MySolution", "MySolution");

    string templatePath = solution.GetProjectTemplate("ConsoleApplication.zip", "CSharp");
    string projectPath = @"F:\Dev\Visual Studio 2013\Packages\Spikes\VSPNewSolution\\Test\MySolution\MyProject";

    /*
     * from MZTools site :
     * Once you have the template file name, you can add a project to the solution using the EnvDTE80.Solution.AddFromTemplate method.
     * Note: this method returns null (Nothing) rather than the EnvDTE.Project created, 
     * so you may need to locate the created project in the Solution.Projects collection. 
     * See PRB: Solution.AddXXX and ProjectItems.AddXXX methods return Nothing (null).
     */
    EnvDTE.Project project = solution.AddFromTemplate(templatePath, projectPath, "MyProject", false);

    EnvDTE.ProjectItem projectItem;
    String itemPath;

    // Point to the first project
    project = solution.Projects.Item(1); // try also "MyProject"

    VSLangProj.VSProject vsProject = (VSLangProj.VSProject)project.Object;
    vsProject.References.Add("NUnit.Framework");

    // Retrieve the path to the class template.
    itemPath = solution.GetProjectItemTemplate("Class.zip", "CSharp");

    //Create a new project item based on the template, in this case, a Class.
    projectItem = project.ProjectItems.AddFromTemplate(itemPath, "MyClass.cs");
}
catch (Exception ex) {
    System.Windows.Forms.MessageBox.Show("ERROR: " + ex.Message);
}

我设法使用 VSLangProj 添加对 MyProject 的引用。
到目前为止，这么好结果类是：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace MyProject
{
    class MyClass
    {
    }
}

在大量googleing之后我没有找到的是一种添加using指令的方法在类代码中（使用NUnit.Framework;在这种情况下是）琐碎的方法是直接编写行操作类文档有没有办法使用Visual Studio Extensibility以编程方式执行此操作？

更新

在尝试获取创建的类的 CodeClass 对象之后，我尝试了 Finding a ProjectItem by type name via DTE中发布的代码几乎没有变化。这是更新的代码：

EnvDTE.DTE dte = this.GetService(typeof(Microsoft.VisualStudio.Shell.Interop.SDTE)) as EnvDTE.DTE;
EnvDTE80.Solution2 solution = (EnvDTE80.Solution2)dte.Solution;
try {

    string solutionPath = @"F:\Dev\Visual Studio 2013\Packages\Spikes\VSPNewSolution\Test\MySolution";
    solution.Create(solutionPath, "MySolution");

    string templatePath = solution.GetProjectTemplate("ConsoleApplication.zip", "CSharp");
    string projectPath = @"F:\Dev\Visual Studio 2013\Packages\Spikes\VSPNewSolution\\Test\MySolution\MyProject";

    EnvDTE.Project project = solution.AddFromTemplate(templatePath, projectPath, "MyProject", false);

    EnvDTE.ProjectItem projectItem;
    String itemPath;

    foreach (EnvDTE.Project p in solution.Projects) {
        if (p.Name == "MyProject") {
            project = p;
            break;
        }
    }

    VSLangProj.VSProject vsProject = (VSLangProj.VSProject)project.Object;
    vsProject.References.Add("NUnit.Framework");

    itemPath = solution.GetProjectItemTemplate("Class.zip", "CSharp");
    projectItem = project.ProjectItems.AddFromTemplate(itemPath, "MyClass.cs");

    // I decided to save both, just in case
    solution.SaveAs(solutionPath + @"\MySolution.sln");
    project.Save();

    EnvDTE.CodeClass codeClass = FindClass(project, "MyClass.cs");

    // Display the source code for the class (from MSDN).

    if (codeClass != null) {
        EnvDTE.TextPoint start = codeClass.GetStartPoint(EnvDTE.vsCMPart.vsCMPartWhole);
        EnvDTE.TextPoint finish = codeClass.GetEndPoint(EnvDTE.vsCMPart.vsCMPartWhole);
        string src = start.CreateEditPoint().GetText(finish);
        System.Windows.Forms.MessageBox.Show(src, codeClass.FullName + "Source"); 
    }
}
catch (Exception ex) {
    System.Windows.Forms.MessageBox.Show("ERROR: " + ex.Message);
    }
}

private CodeClass FindClass(Project project, string className) {
    return FindClass(project.CodeModel.CodeElements, className);
}

private CodeClass FindClass(CodeElements elements, string className) {
    foreach (CodeElement element in elements) {
        if (element is CodeNamespace || element is CodeClass) {
            CodeClass c = element as CodeClass;
            if (c != null && c.Access == vsCMAccess.vsCMAccessPublic) {
                if (c.FullName == className)
                    return c;

                CodeClass subClass = FindClass(c.Members, className);
                if (subClass != null)
                    return subClass;
            }

            CodeNamespace ns = element as CodeNamespace;
            if (ns != null) {
                CodeClass cc = FindClass(ns.Members, className);
                if (cc != null)
                    return cc;
            }
        }
    }
    return null;
}

嗯，事实证明 FindClass 总是返回null，因为project.CodeModel.CodeElements.Count为零。呃？

更新2
好吧，请不要打败我。原始代码在 projectPath 变量中有多余的反斜杠。
这导致project.CodeModel.CodeElements.Count为零此外， FindClass 需要没有扩展名的 FullName 类，并且只搜索 public 类。
我更正了代码，但仍然得到了 null （我自己的错，我猜：我一定错过了什么）。
无论如何， FindClass 在所有项目CodeElements中搜索给定的类，包括项目参考。
在我的案例中，这是一种矫枉过正，因为我正在搜索该项目的本地课程所以我写了一个功能就是这样。
这是：

public static CodeClass FindClassInProjectItems(Project project, string className) {
            CodeClass result = null;
            foreach (EnvDTE.ProjectItem pi in project.ProjectItems) {                
                if (pi.Name == className + ".cs") {
                    if (pi.FileCodeModel != null) {
                        foreach (EnvDTE.CodeElement ce in pi.FileCodeModel.CodeElements) {
                            if (ce is EnvDTE.CodeClass) {
                                result = ce as EnvDTE.CodeClass;
                                break;
                            }
                            else if (ce is EnvDTE.CodeNamespace) {
                                CodeNamespace ns = ce as CodeNamespace;

                                if (ns.Name == project.Name) {
                                    foreach (CodeElement sce in ns.Members) {
                                        if (sce is CodeClass && sce.Name == className) {
                                            result = sce as CodeClass;
                                            break;
                                        }
                                    }
                                }                                    
                            }
                        }
                    }
                }        
            }
            return result;
        }

它有效，所以我创建了一个静态 ClassFinder 类并添加了该功能下一步是检索完整的类源代码，包括using指令我在MSDN here上找到了一个示例，这是关键代码：

// Display the source code for the class.
TextPoint start = cls.GetStartPoint(vsCMPart.vsCMPartWhole);
TextPoint finish = cls.GetEndPoint(vsCMPart.vsCMPartWhole);
string src = start.CreateEditPoint().GetText(finish);

实际上，第一行会引发异常所以我尝试了 vsCMPart 枚举的所有成员：大多数成员抛出异常，除了： vsCMPart.vsCMPartBody ， vsCMPart.vsCMPartHeader ， vsCMPart.vsCMPartNavigate 和 vsCMPart.vsCMPartWholeWithAttributes 。
vsCMPart.vsCMPartHeader 和 vsCMPart.vsCMPartWholeWithAttributes 返回相同的结果（至少在这种情况下），

而其他人则不返回整个代码保持简短：

private void DisplayClassSource(CodeClass codeClass) {
    EnvDTE.TextPoint start = codeClass.GetStartPoint(vsCMPart.vsCMPartHeader);
    EnvDTE.TextPoint finish = codeClass.GetEndPoint();
    string source = start.CreateEditPoint().GetText(finish);        
    System.Windows.Forms.MessageBox.Show(source, codeClass.FullName + "Class source");
}   

private void DisplayNamespaceSource(CodeNamespace codeNamespace) {
    EnvDTE.TextPoint start = codeNamespace.GetStartPoint(EnvDTE.vsCMPart.vsCMPartWholeWithAttributes);
    EnvDTE.TextPoint finish = codeNamespace.GetEndPoint();
    string src = start.CreateEditPoint().GetText(finish);
    System.Windows.Forms.MessageBox.Show(src, codeNamespace.FullName + "Namespace source");
}

如果我们想要IDE中出现的源代码，包括using指令，
我们必须使用classCode.ProjectItem对象：

    private void DisplayClassFullSource(CodeClass codeClass) {
        System.Text.StringBuilder sb = new System.Text.StringBuilder();
        foreach (CodeElement ce in codeClass.ProjectItem.FileCodeModel.CodeElements) {
            if (ce.Kind == vsCMElement.vsCMElementImportStmt) {
                // this is a using directive
                // ce.Name throws an exception here !
                sb.AppendLine(GetImportCodeLines(ce));
            }
            else if (ce.Kind == vsCMElement.vsCMElementNamespace) {
                sb.AppendLine();
                sb.AppendLine(GetNamespaceCodeLines(ce));
            }
        }

        System.Windows.Forms.MessageBox.Show(sb.ToString(), codeClass.FullName + "class source");
    }

    private static string GetImportCodeLines(CodeElement ce) {
        TextPoint start = ce.GetStartPoint(vsCMPart.vsCMPartWholeWithAttributes);
        TextPoint finish = ce.GetEndPoint(vsCMPart.vsCMPartWholeWithAttributes);
        return start.CreateEditPoint().GetText(finish);
    }

    private string GetNamespaceCodeLines(CodeElement ce) {
        EnvDTE.TextPoint start = ce.GetStartPoint(vsCMPart.vsCMPartWholeWithAttributes);
        //EnvDTE.TextPoint finish = codeClass.GetEndPoint(EnvDTE.vsCMPart.vsCMPartWhole); // ERROR : the method or operation is not implemented
        EnvDTE.TextPoint finish = ce.GetEndPoint();
        return start.CreateEditPoint().GetText(finish);
    }

现在我们非常接近问题的解决方案。看我的回答。（对不起，如果这看起来像小说）

Answer 1

据我所知，在CodeClass中添加using指令没有直接的方法我发现的唯一方法是：
它肯定需要改进，但它的工作原理此代码假定所有using指令都在类代码顶部的行中例如，如果命名空间中存在using指令，它将无法正常工作它在最后一次找到之后添加了给定的指令它不检查代码以确定指令是否已存在。

    private void AddUsingDirectiveToClass(CodeClass codeClass, string directive) {
        CodeElement lastUsingDirective = null;

        foreach (CodeElement ce in codeClass.ProjectItem.FileCodeModel.CodeElements) {
            if (ce.Kind == vsCMElement.vsCMElementImportStmt) {
                // save it
                lastUsingDirective = ce;
            }
            else {
                if (lastUsingDirective != null) {
                    // insert given directive after the last one, on a new line
                    EditPoint insertPoint = lastUsingDirective.GetEndPoint().CreateEditPoint();
                    insertPoint.Insert("\r\nusing " + directive + ";");
                }
            }
        }
    }

所以，最终的工作代码是

        EnvDTE.DTE dte = this.GetService(typeof(Microsoft.VisualStudio.Shell.Interop.SDTE)) as EnvDTE.DTE;
        EnvDTE80.Solution2 solution = (EnvDTE80.Solution2)dte.Solution;
        try {
            /*
             * NOTE while the MSDN sample states you must open an existing solution for the code to work,
             * it works also without opening a solution.
             */
            string solutionPath = @"F:\Dev\Visual Studio 2013\Packages\Spikes\VSPNewSolution\Test\MySolution";
            solution.Create(solutionPath, "MySolution");

            string templatePath = solution.GetProjectTemplate("ConsoleApplication.zip", "CSharp");
            string projectPath = solutionPath + @"\MyProject";

            /*
             * from MZTools site :
             * Once you have the template file name, you can add a project to the solution using the EnvDTE80.Solution.AddFromTemplate method.
             * Note: this method returns null (Nothing) rather than the EnvDTE.Project created, 
             * so you may need to locate the created project in the Solution.Projects collection. 
             * See PRB: Solution.AddXXX and ProjectItems.AddXXX methods return Nothing (null).
             */
            EnvDTE.Project project = solution.AddFromTemplate(templatePath, projectPath, "MyProject", false); 

            // the following code would do since there is only a single project
            //project = solution.Projects.Item(1); 

            // tried this :
            // project = solution.Projects.Item("MyProject"); 
            // but it throws an invalid argument exception

            // search project by name
            foreach (EnvDTE.Project p in solution.Projects) {
                if (p.Name == "MyProject") {
                    project = p;
                    break;
                }
            }

            // add a reference to NUnit
            VSLangProj.VSProject vsProject = (VSLangProj.VSProject)project.Object;
            vsProject.References.Add("NUnit.Framework");

            // Retrieve the path to the class template.
            string itemPath = solution.GetProjectItemTemplate("Class.zip", "CSharp");

            //Create a new project item based on the template, in this case, a Class.

            /*
             * Here we find the same problem as with solution.AddFromTemplate(...) ( see above )
             */
            EnvDTE.ProjectItem projectItem = project.ProjectItems.AddFromTemplate(itemPath, "MyClass.cs");

            solution.SaveAs(solutionPath + @"\MySolution.sln");                                
            project.Save();

            // retrieve the new class we just created
            EnvDTE.CodeClass codeClass = ClassFinder.FindClassInProjectItems(project, "MyClass");                               

            if (codeClass != null) {
                DisplayClassFullSource(codeClass);
                AddUsingDirectiveToClass(codeClass, "NUnit.Framework");
                project.Save();
                DisplayClassFullSource(codeClass);
            }


        }
        catch (Exception ex) {
            System.Windows.Forms.MessageBox.Show("ERROR: " + ex.Message);
        }            
    }

<强> P.S。
在接受这个答案之前，我会等待一段时间以防其他人发布更好的解决方案。

修改
时间过去了，没有关于这个问题的进一步帖子我将此标记为已接受的答案。

以编程方式向类添加using指令

1 个答案: