VS 编码规范---- 代码注释设置
一个良好的代码风格在开发过程和后期维护过程中是必不可少的。每次在添加新类的时候都需要添加一些关于类的注释,包括创建时间、创建人、类的功能介绍、修改时间等一系列的信息,以方便以后的查找和快速了解。在Code Review过程中,良好的编码风格和合理的注释会有很大的帮助。
下面介绍一点我的编辑器中关于代码风格的配置和注释的配置.
1.关于类注释和方法注释:
类注释可以通过以下手段进行注释:
1)修改类模板的形式:
步骤如下:
a. 找到VS的安装路径,如:C:/vs2017,打开如下文件夹\Common7\IDE\ItemTemplates。可以看到文件夹下有这些文件模板:
如果你想对C#代码进行注释配置,打开CSharp\Code\2052,可以看到该文件夹下有class、Interface、WebClass等文件夹。打开class文件夹,
b.修改文件权限:class.cs文件(该文件就是创建一个C#类的模板)。我们需要先设置一下管理员账户才可以修改该类:右键该文件
给当前用户分配权限即可。
c.修改该类的内容,可以添加如下内容,当然可以进行对应的删减。该段内容我会放在文件的开始或者using引用之后。
#region << 版 本 注 释 >>
/*----------------------------------------------------------------
* 项目名称 :$rootnamespace$
* 项目描述 :
* 类 名 称 :$safeitemname$
* 类 描 述 :
* 所在的域 :$userdomain$
* 命名空间 :$rootnamespace$
* 机器名称 :$machinename$
* CLR 版本 :$clrversion$
* 作 者 :$username$
* 创建时间 :$time$
* 更新时间 :$time$
* 版 本 号 :v1.0.0.0
*******************************************************************
* Copyright @ $username$ $year$. All rights reserved.
*******************************************************************
//----------------------------------------------------------------*/
#endregion
新建一个类文件尝试一下,效果如图所示:
注: 对于不同类型的项目文件类,要对该类型的项目文件类进行修改。如果我想修改一下ASP.NET Core的类,那么需要打开Common7\IDE\ItemTemplates\AspNetCore\Code\1033\Class。
2)使用code snippet的方式添加注释:
codesnippet 代码片段,就是使用自定义快捷键生成代码注释,也就是自定义一段代码片段,该方法可以用于类文件描述和方法描述上。步骤如下:
a. 创建代码片段:
在电脑的任意可访问的位置创建一个文件夹,如我在C:\VSSnippet,新建一个.snippet后缀的文件,一般文件名和你在VS中使用的快捷键名字对应。
b.参照visual studio官网上关于code snippet的写法,编写代码片段。也可以直接去vs自带的代码片段中复制一份进行修改。
VS自带的代码片段位于:vs安装目录\VC#\Snippets\2052\Visual C#,我们可以复制一份cw.snippet文件到之前的文件夹下,并重命名为cm.snippet( create comments,该文件名可以随便写)
修改文件内容如下:
<?xml version="1.0" encoding="utf-8"?>
<CodeSnippets xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">
<CodeSnippet Format="1.0.0">
<Header>
<Title>创建代码注释</Title>
<Shortcut>cm</Shortcut>
<Description>创建注释的代码片段</Description>
<Author>King</Author>
<SnippetTypes>
<SnippetType>Expansion</SnippetType>
</SnippetTypes>
</Header>
<Snippet>
<Declarations>
<Literal>
<ID>Description</ID>
<ToolTip>功能</ToolTip>
<Default>描述</Default>
</Literal>
<Literal>
<ID>Author</ID>
<ToolTip>作者</ToolTip>
<Default>King</Default>
</Literal>
<Literal>
<ID>CreateTime</ID>
<ToolTip>创建日期</ToolTip>
<Default>@@Today</Default>
</Literal> </Declarations>
<Code Language="csharp"><![CDATA[
#region 创建描述
/***
* 功能描述: $Description$
* 作 者: $Author$
* 创建时间: $CreateTime$
***/
#endregion
$end$
]]>
</Code>
</Snippet>
</CodeSnippet>
</CodeSnippets>
c. 在Visual Studio中应用代码片段
打开VS IDE,工具----> 代码片段管理(快捷键Ctrl + K, Ctrl + B),将刚创建的代码片段文件夹添加到代码片段管理器中。重启VS,在文件中是输入cm(在codesnippet中定义的<Shortcut>cm</Shortcut>)
双击Tab键就可以插入代码片段了。
两种方式比较:
优点:
1.修改VS class模板的形式,该注释中可以包含很多信息。如作者、时间等信息
2.使用代码注释的形式,可以在类上添加注释,也可以在方法上添加注释。
不足:
1.修改VS class模板,只能在类创建的时候使用,并且不能在方法上添加注释、
2.使用代码注释的形式,有一些信息无法自动化处理,如时间等。当然可以使用VS 宏定义来定义函数,插入时间。
提高代码质量插件:
CodeMaid : 可快速整理代码文件,清理不必要的代码和杂乱的格式。并在开发时实时提供代码复杂度的报告,以便帮助开发人员降低代码复杂度、提高代码质量。
VS 编码规范---- 代码注释设置的更多相关文章
- Eclipse编码规范——Code Templates设置
Eclipse编码规范——Code Templates设置 Eclipse编码规范主要包括三个方面:设置Code Templates.Eclipse formatter.Checkstyle, 本篇主 ...
- JAVA_SE基础——编码规范&代码编写规则
这次我来给大家说明下编码规范&代码编写规则 ↓ 编码规范可以帮助程序员在编程时注意一些细节问题,提高程序的可读性,让程序员能够尽快地理解新的代码,并帮助大家编写出规范的利于维护的Java代码 ...
- 《从零开始学Swift》学习笔记(Day 57)——Swift编码规范之注释规范:文件注释、文档注释、代码注释、使用地标注释
原创文章,欢迎转载.转载请注明:关东升的博客 前面说到Swift注释的语法有两种:单行注释(//)和多行注释(/*...*/).这里来介绍一下他们的使用规范. 1.文件注释 文件注释就在每一个文件开头 ...
- PHP团队 编码规范 & 代码样式风格规范
一.基本约定 1.源文件 (1).纯PHP代码源文件只使用 <?php 标签,省略关闭标签 ?> : (2).源文件中PHP代码的编码格式必须是无BOM的UTF-8格式: (3).使用 U ...
- 自己总结的C#编码规范--4.注释篇
注释 注释毫无疑问是让别人以最快速度了解你代码的最快途径,但写注释的目的绝不仅仅是"解释代码做了什么",更重要的尽量帮助代码阅读者对代码了解的和作者一样多. 当你写代码时,你脑海里 ...
- java代码注释规范
java代码注释规范 代码注释是架起程序设计者与程序阅读者之间的通信桥梁,最大限度的提高团队开发合作效率.也是程序代码可维护性的重要环节之一.所以我们不是为写注释而写注释.下面说一下我们在诉求网二 ...
- 推荐的PHP编码规范
推荐的PHP编码规范 发布时间: 2014-05-7 浏览次数:2754 分类: PHP教程 推荐的PHP编码规范 一 编辑器设置 1. 使用Tab缩进,不要使用空格 鉴于很多编辑器在保存文件时会自动 ...
- iOS编码规范参考
目录 注释 1.1 多行注释 1.2 单行注释 1.3 函数的注释 命名 2.1 常量的命名 2.2 函数的命名 2.3 变量的命名 2.3.1 成员变量 2.3.2 公 ...
- Python 常用 PEP8 编码规范
Python 常用 PEP8 编码规范 代码布局 缩进 每级缩进用4个空格. 括号中使用垂直隐式缩进或使用悬挂缩进. EXAMPLE: ? 1 2 3 4 5 6 7 8 9 10 11 12 13 ...
随机推荐
- 【pytorch】关于Embedding和GRU、LSTM的使用详解
1. Embedding的使用 pytorch中实现了Embedding,下面是关于Embedding的使用. torch.nn包下的Embedding,作为训练的一层,随模型训练得到适合的词向量. ...
- BZOJ5019[Snoi2017]遗失的答案——FWT+状压DP
题目描述 小皮球在计算出答案之后,买了一堆皮肤,他心里很开心,但是一不小心,就忘记自己买了哪些皮肤了.==|||万 幸的是,他还记得他把所有皮肤按照1-N来编号,他买来的那些皮肤的编号(他至少买了一款 ...
- docker容器的安装与使用
docker 容器概念 1.什么是容器 容器就是在隔离环境运行的一个进程,如果进程停止,容器就会销毁.隔离的环境拥有自己的系统文件,IP地址,主机名等. kvm虚拟机,linux,系统文件 程序: 代 ...
- Flask 构建微电影视频网站(七)
电影模块实现 上映预告 @home.route("/animation/") def animation(): """ 首页轮播动画 "&q ...
- 【BZOJ3997】[TJOI2015]组合数学(动态规划)
[BZOJ3997][TJOI2015]组合数学(动态规划) 题面 BZOJ 洛谷 题解 相当妙的一道题目.不看题解我只会暴力网络流 先考虑要求的是一个什么东西,我们把每个点按照\(a[i][j]\) ...
- Vue状态管理之Vuex
Vuex是专为Vue.js设计的状态管理模式.采用集中存储组件状态它采用集中式存储管理应用的所有组件的状态,并以相应的规则保证状态以一种可预测的方式发生变化. 1.首先让我们从一个vue的计数应用开始 ...
- DataReader转Dictionary数据类型之妙用
datareader转dictionary有很多用处,可以输出表中部分字段转实体字段,以前需要全部字段输出或者再建一个实体模型才行,这样就可以减少数据库的输出量了,特别是某些接口的格式化输出很方便. ...
- pytest 13 使用自定义标记mark
前言: pytest可以规定那些要跑,那些不跑,跑特定的哪些?比如以下的这个例子: #!/usr/bin/env/python # -*-coding:utf-8-*- import pytest @ ...
- 爬虫综合大作业——网易云音乐爬虫 & 数据可视化分析
作业要求来自于https://edu.cnblogs.com/campus/gzcc/GZCC-16SE2/homework/3075 爬虫综合大作业 选择一个热点或者你感兴趣的主题. 选择爬取的对象 ...
- 【linux】常用命令集锦&持续更新...
滴:转载引用请注明哦[握爪]:https://www.cnblogs.com/zyrb/p/9709013.html 对深度学习训练及日常work中的常用linux命令进行整理. [一]screen ...