使用 EnvDTE 以编程方式将函数添加到现有 C# 文件

Question

我想以编程方式将一个函数（一个 TestMethod）添加到现有的 C# 文件中。 经过一番谷歌搜索，我找到了库 EnvDTE 和 CodeModel.AddFunction-Method，但我找不到我想要的一个很好的例子。

我想在新创建的函数中添加一个带有代码的函数以及一个属性。像这样的：

/// <summary>
/// Documentation
/// </summary>
[TestMethod]
public void TestMethod1()
{
    string test = Helper.CodeExample();
}

谁能给我举个例子来说明如何做到这一点？

编辑：我想编辑一个 C# 文件，就像你编辑一个文本文件一样。我知道您可以使用 StreamWriter 来做到这一点，但是否有更好的方法来做到这一点？

Answer 1

EnvDTE 可能是要走的路。您可以开发 VisualStudio 加载项，然后修改 Exec 方法。在此方法中，您必须获取活动文档及其 ProjectItem。在这里您可以找到包含大量 CodeElement 的 CodeModel。在这些元素中，您必须找到 CodeNamespace，并在此元素中找到 CodeClass。这是响应 AddFunction 的对象，它返回新的 CodeFunction，您可以在其中添加属性和代码（这是我不太喜欢的部分，因为您必须使用 EditPoint）。

这是一个非常简单的 Exec 版本，您可以将其用作起点：

    public void Exec(string commandName, vsCommandExecOption executeOption, ref object varIn, ref object varOut, ref bool handled)
    {
        handled = false;
        if(executeOption == vsCommandExecOption.vsCommandExecOptionDoDefault)
        {
            handled = true;
            if (commandName == "TestAddMethod.Connect.TestAddMethod")
            {
                Document activeDoc = _applicationObject.ActiveDocument;
                if (activeDoc == null)
                    return;
                ProjectItem prjItem = activeDoc.ProjectItem;
                if (prjItem == null)
                    return;
                FileCodeModel fcm = prjItem.FileCodeModel;
                if (fcm == null)
                    return;

                CodeElements ces = fcm.CodeElements;
                // look for the namespace in the active document
                CodeNamespace cns = null;
                foreach (CodeElement ce in ces)
                {
                    if (ce.Kind == vsCMElement.vsCMElementNamespace)
                    {
                        cns = ce as CodeNamespace;
                        break;
                    }
                }
                if (cns == null)
                    return;
                ces = cns.Members;
                if (ces == null)
                    return;
                // look for the first class
                CodeClass cls = null;
                foreach (CodeElement ce in ces)
                {
                    if (ce.Kind == vsCMElement.vsCMElementClass)
                    {
                        cls = ce as CodeClass;
                        break;
                    }
                }
                if (cls == null)
                    return;
                CodeFunction cf = cls.AddFunction("TestMethod1", vsCMFunction.vsCMFunctionFunction, vsCMTypeRef.vsCMTypeRefVoid, -1, vsCMAccess.vsCMAccessPrivate);
                cf.AddAttribute("TestMethod", "true");
                TextPoint tp = cf.GetStartPoint(vsCMPart.vsCMPartBody);
                EditPoint ep = tp.CreateEditPoint();
                ep.Indent();
                ep.Indent();
                ep.Indent();
                ep.Insert("string test = Helper.CodeExample();");
            }
        }
    }