Loading

Visual Studio C#函数注释模板修改

当团队开发项目时,函数可能会经常反复修改,为了方便记录修改信息,可能需要修改注释格式

为了记录这些信息,注释更改为:

/// <summary>
/// 保存用户信息
/// </summary>
/// <remarks>
/// @author 张三
/// @date 2025/5/6
/// @updater 李四
/// @date 2025/5/7
/// </remarks>
public void SaveUserInfo()
{

}

如果每次都复制粘贴此注释势必有些麻烦,我们可以利用Visual Studio的(工具)->(代码片段管理器)来实现
找到Visual Studio下的Community\VC#\Snippets\2052\Visual C#\ 目录
新建文件FunctionComment.snippet

内容如下:

<CodeSnippet Format="1.0.0" xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
  <Header>
    <Title>Custom Function Comment</Title>
    <Shortcut>zs</Shortcut>
  </Header>
  <Snippet>
    <Code Language="csharp">
      <![CDATA[
    /// <summary>
    /// 注释
    /// </summary>
    /// <remarks>
    /// @author 作者
    /// @date 2020/1/1
    /// @updater 
    /// @date 
    /// </remarks>]]>
    </Code>
  </Snippet>
</CodeSnippet>

如果保存不了在外层Visual C#目录给当前用户操作文件夹的权限

此时在vs中输入zs,按tab即可补全生成此注释代码片段,如果没反应重启vs即可

posted @ 2025-05-06 17:34  Stay627  阅读(110)  评论(0)    收藏  举报