46

经过一番谷歌搜索后，我发现了这一点：使用 Visual Studio 宏将版权标题插入源文件。它看起来很有希望：

// <copyright file="Sample.cs" company="My Company Name">
// Copyright (c) 2012 All Rights Reserved
// </copyright>
// <author>Leniel Macaferi</author>
// <date>08/30/2012 11:39:58 AM </date>
// <summary>Class representing a Sample entity</summary>

当我尝试Tools -> Macros菜单选项时，它在 VS 2012 中不再存在。这是证明：Macros in Visual Studio 11 Developer Preview。他们只是放弃了这个功能。:(

所以，我只是想知道我可以使用哪个选项将版权信息添加到使用 Visual Studio 2012 的解决方案中的所有现有源代码文件中。是否有任何标准方法可以使用模板文件（与 T4 templates) 还是PowerShell脚本？我可以编写一些代码来遍历带有.cs扩展名的文件并添加版权信息，但这不是我想要的。我想知道一些工具来自动化这个过程。

4

7 回答 7

37

您可以创建一个新的片段，只需键入 cp + double tab 即可在您想要的位置插入通知（不用说您可以将关键字更改为您想要的任何内容）。

唯一的问题是，据我所知，片段不支持时间函数，因此使用这种技术似乎不可能获得日期线的当前时间。一个不太好的解决方法是使时间字段可编辑（类似于 mbox 片段的工作方式）并手动插入时间。

这是一个关于片段外观的示例。下面的代码片段将自动获取类名，并在您键入“版权”和双标签的地方插入版权声明。

方法一

 <?xml version="1.0" encoding="utf-8" ?>
<CodeSnippets  xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
  <CodeSnippet Format="1.0.0">
    <Header>
      <Title>Copyright</Title>
      <Shortcut>Copyright</Shortcut>
      <Description>Code snippet for Copyright notice</Description>
      <Author>author name</Author>
      <SnippetTypes>
        <SnippetType>Expansion</SnippetType>
      </SnippetTypes>
    </Header>
    <Snippet>
      <Declarations>
        <Literal Editable="false">
          <ID>classname</ID>
          <Function>ClassName()</Function>
        </Literal>
      </Declarations>
      <Code Language="csharp">
        <![CDATA[// <copyright file="$classname$" company="My Company Name">
      // Copyright (c) 2012 All Rights Reserved
      // <author>Leniel Macaferi</author>
      // </copyright>
      ]]>
      </Code>
    </Snippet>
  </CodeSnippet>
</CodeSnippets>

方法二

此外，这里有一个程序示例，您可以为您执行此操作。

List<string> files = new List<string>()
{
    "c:\\Form1.cs",
    "c:\\Form2.cs",
};

foreach (string file in files)
{
    string tempFile = Path.GetFullPath(file) + ".tmp";

    using (StreamReader reader = new StreamReader(file))
    {
        using (StreamWriter writer = new StreamWriter(tempFile))
        {
            writer.WriteLine(@"// <copyright file=" + Path.GetFileNameWithoutExtension(file) + @" company=My Company Name>
// Copyright (c) 2012 All Rights Reserved
// </copyright>
// <author>Leniel Macaferi</author>
// <date> " + DateTime.Now + @"</date>
// <summary>Class representing a Sample entity</summary>
");

            string line = string.Empty;
            while ((line = reader.ReadLine()) != null)
            {
                writer.WriteLine(line);
            }
        }
    }
    File.Delete(file);
    File.Move(tempFile, file);
}

当然需要一些错误捕获。但这应该让您大致了解如何围绕它构建 UI 并添加您想要处理的文件。

方法三

也可以更改您的类的模板，这些模板通常可以在以下位置找到：

C:\Program Files (x86)\Microsoft Visual Studio <version>\Common7\IDE\ItemTemplates\CSharp\1033\

有时也需要编辑ItemTemplatesCache来显示结果。

这是基于您的问题的示例模板：

using System;
using System.Collections.Generic;
$if$ ($targetframeworkversion$ >= 3.5)using System.Linq;
$endif$using System.Text;

/* <copyright file=$safeitemrootname$ company="My Company Name">
   Copyright (c) 2012 All Rights Reserved
   </copyright>
   <author>Leniel Macaferi</author>
   <date>$time$</date>
   <summary>Class representing a Sample entity</summary>*/

namespace $rootnamespace$
{
    class $safeitemrootname$
    {
    }
}
于 2012-08-30T15:23:08.783 回答
23

我将在此处添加我在这篇文章中找到的 PowerShell 脚本：Powershell – 版权标头生成器脚本。它捕捉了我在发布问题之前的想法......

param($target = "C:\MyProject", $companyname = "My Company")

$header = "//-----------------------------------------------------------------------

// <copyright file=""{0}"" company=""{1}"">

// Copyright (c) {1}. All rights reserved.

// </copyright>

//-----------------------------------------------------------------------`r`n"

function Write-Header ($file)
{
    $content = Get-Content $file

    $filename = Split-Path -Leaf $file

    $fileheader = $header -f $filename,$companyname

    Set-Content $file $fileheader

    Add-Content $file $content
}

Get-ChildItem $target -Recurse | ? { $_.Extension -like ".cs" } | % `
{
    Write-Header $_.PSPath.Split(":", 3)[2]
}

我写了一些关于它的小修改以适应我的需要：

使用 PowerShell 在所有源代码文件中插入版权声明/横幅/标题

于 2012-08-30T19:56:50.997 回答
10

万一这可能仍然很有趣，有许可证头插件可以在创建时向任何文件添加完全可定制的头。目前，这确实适用于 VS2013，但不适用于（还？）VS 2015。

于 2015-08-17T16:44:26.810 回答
4

根据发行说明 和发行说明（向下滚动一点），Visual Studio 16.6 允许定义可用于创建文件横幅的file_header_template规则。.editorconfig

于 2020-05-26T14:49:31.210 回答
3

使用以下行将 .editorconfig 文件添加到您的 Visual Studio 项目中：

file_header_template = // <copyright file="{fileName}.cs" company="xyz Corporation">\n// Copyright (c) Xyz Corporation. All rights reserved.\n// </copyright>

接下来，将光标放在任何 C# 或 Visual Basic 文件的第一行并键入 (Ctrl+.) 以触发 Quick Actions and Refactorings 菜单。选择添加文件横幅。如果您想将文件头应用于现有项目或解决方案的所有文件，请在“修复所有出现在：”选项下选择项目或解决方案。

这种方法适用于新文件甚至现有文件。这是内置在 Visual Studio 代码中的，因此您不需要自定义脚本。

此处的详细信息：https ://docs.microsoft.com/en-us/visualstudio/releases/2019/release-notes-v16.6#net-productivity:~:text=Add%20file%20headers%20to%20existing%20files

于 2021-04-28T15:29:13.743 回答
2

在失去了一些不起眼的 PowerShell 脚本（不是作为答案添加的脚本）之后，我决定创建copyright.py。示例用法：

C:\>python copyright.py "C:\users\me\documents\path\to\vsproject"

它递归地查找指定目录中的所有 *.cs 文件，并在它们前面加上版权文本。文件开头是否已经存在其他文本无关紧要；它将被删除。

注意： 作为预防措施，您应该始终在执行此脚本之前备份您的代码

于 2014-10-30T16:37:37.733 回答
0

@leniel-macaferi 的代码的更简单版本（没有文件名和公司，只有标题）：

param($target = "C:\MyProject")

$header = "//-----------------------------------------------------------------------------
// Copyright (c) The Corporation.  All rights reserved.
//-----------------------------------------------------------------------------
"

function Write-Header ($file)
{
    $content = Get-Content $file
    $filename = Split-Path -Leaf $file
    $fileheader = $header
    Set-Content $file $fileheader
    Add-Content $file $content
}

Get-ChildItem $target -Recurse | ? { $_.Extension -like ".cs" } | % `
{
    Write-Header $_.PSPath.Split(":", 3)[2]
}

要运行，请将代码保存在要递归迭代并.\AddHeader.ps1 .从 PowerShell 窗口执行的目录中的新文件（例如 AddHeader.ps1）中。

于 2015-07-21T23:35:12.993 回答