[学习资料] 最新的Microsoft Visual Studio新建文件自动添加注释教程

[复制链接]
2586|14
 楼主| hehhehee 发表于 2023-6-30 02:15 | 显示全部楼层 |阅读模式
前言
一个合格的程序员不仅要会写程序而且还需要让别人读懂你的程序,有时候想让别人读懂的你代码是一件很难得事情,最新接手了一个之前离职人员的项目,需要改bug,这是就来了一件很头疼的事情,看不懂,看懂了不敢动,项目是国内项目,不想对日项目那样有概要,详细等,甚至一页代码里能找见20行注释就已经是很不错了。

一、注释是什么?
注释就是对代码的解释和说明,其目的是让人们能够更加轻松地了解代码。注释是编写程序时,写程序的人给一个语句、程序段、函数等的解释或提示,能提高程序代码的可读性。

注释只是为了提高可读性,不会被计算机编译。

二、自动添加头部注释
只能指定位置添加注释,并不是你写一行代码就会生成一个注释的,不要误解,毕竟你写的是你的代码。

1.添加注释教程
第一步:找到VS安装的路径,忘记了就点击VS图标,右键属性找到起始位置。



第二步:在安装路径下继续往下找一个叫Class.cs的文件。
本地vs2022为例:

属性中的起始路径:C:\Program Files\Microsoft Visual Studio\2022\Enterprise\Common7\IDE,在起始路径-----> ItemTemplates -----> CSharp -----> Code -----> 2052 -----> Class -----> Class.cs

整体路径大概是这样的:C:\Program Files\Microsoft Visual Studio\2022\Enterprise\Common7\IDE\ItemTemplates\CSharp\Code\2052\Class\Class.cs

第三步:修改Class.cs文件的内容

第一次打开class文件是初始状态:这是每次创建类时都会自动给你生成的代码




本帖子中包含更多资源

您需要 登录 才可以下载或查看,没有账号?注册

×
 楼主| hehhehee 发表于 2023-6-30 02:15 | 显示全部楼层
  1. using System;
  2. using System.Collections.Generic;
  3. $if$ ($targetframeworkversion$ >= 3.5)using System.Linq;
  4. $endif$using System.Text;
  5. $if$ ($targetframeworkversion$ >= 4.5)using System.Threading.Tasks;
  6. $endif$
  7. namespace $rootnamespace$
  8. {
  9.     class $safeitemrootname$
  10.     {
  11.     }
  12. }
 楼主| hehhehee 发表于 2023-6-30 02:16 | 显示全部楼层
只要在这个上面添加你要添加的内容就可以了,下面是我自己常用的,如果需要添加别的可以自行添加
  1. /*-------------------------------------------------------------------------
  2. * 命名空间名称/文件名:    $rootnamespace$/$safeitemname$
  3. * CLR版本:     $clrversion$
  4. * 机器名称:    $machinename$
  5. * 功 能:       N/A
  6. * 类 名:       $safeitemname$
  7. * 创建时间:  $time$
  8. * 版本号:      v1.0
  9. * 创建人:        $username$
  10. *-------------------------------------------------------------------------*/

  11. using System;
  12. using System.Collections.Generic;
  13. $if$ ($targetframeworkversion$ >= 3.5)using System.Linq;
  14. $endif$using System.Text;
  15. $if$ ($targetframeworkversion$ >= 4.5)using System.Threading.Tasks;
  16. $endif$
  17. namespace $rootnamespace$
  18. {
  19.     class $safeitemrootname$
  20.     {
  21.     }
  22. }
 楼主| hehhehee 发表于 2023-6-30 02:16 | 显示全部楼层
添加其他内容时可以参照以下内容:
  1. 代码中的"$"符号之间的字符是模版的变量,具体变量含义请参照:

  2. time$ 日期

  3. $year$ 年份

  4. $clrversion$ CLR版本

  5. $GUID$ 用于替换项目文件中的项目 GUID 的 GUID。最多可以指定 10 个唯一的 GUID(例如,guid1))。

  6. $itemname$ 用户在对话框中提供的名称。

  7. $machinename$ 当前的计算机名称(例如,Computer01)。

  8. $projectname$ 用户在对话框中提供的名称。

  9. $registeredorganization$ HKLMSoftwareMicrosoftWindows NTCurrentVersionRegisteredOrganization 中的注册表项值。

  10. $rootnamespace$ 当前项目的根命名空间。此参数用于替换正向项目中添加的项中的命名空间。

  11. $safeitemname$ 用户在“添加新项”对话框中提供的名称,名称中移除了所有不安全的字符和空格。

  12. $safeprojectname$ 用户在“新建项目”对话框中提供的名称,名称中移除了所有不安全的字符和空格。

  13. $time$ 以 DD/MM/YYYY 00:00:00 格式表示的当前时间。

  14. $userdomain$ 当前的用户域。

  15. $username$ 当前的用户名
 楼主| hehhehee 发表于 2023-6-30 02:16 | 显示全部楼层
添加完保存时可能会出现提供管理员权限的提示,提供管理员权限保存即可,保存之后再回到vs中创建类时上面就自带注释了。
 楼主| hehhehee 发表于 2023-6-30 02:16 | 显示全部楼层
效果如下:
  1. /*-------------------------------------------------------------------------
  2. * 命名空间名称/文件名:    CHigh/_8520
  3. * CLR版本:     4.0.30319.42000
  4. * 机器名称:    DESKTOP-E69M8HM
  5. * 功 能:       N/A
  6. * 类 名:       _8520
  7. * 创建时间:  2022/10/25 10:37:31
  8. * 版本号:      v1.0
  9. * 创建人:        阿乐
  10. *-------------------------------------------------------------------------*/

  11. using System;
  12. using System.Collections.Generic;
  13. using System.Linq;
  14. using System.Text;
  15. using System.Threading.Tasks;

  16. namespace CHigh
  17. {
  18.     internal class _8520
  19.     {
  20.     }
  21. }
 楼主| hehhehee 发表于 2023-6-30 02:17 | 显示全部楼层
添加完保存时可能会出现提供管理员权限的提示,提供管理员权限保存即可,保存之后再回到vs中创建类时上面就自带注释了。

效果如下:
  1. /*-------------------------------------------------------------------------
  2. * 命名空间名称/文件名:    CHigh/_8520
  3. * CLR版本:     4.0.30319.42000
  4. * 机器名称:    DESKTOP-E69M8HM
  5. * 功 能:       N/A
  6. * 类 名:       _8520
  7. * 创建时间:  2022/10/25 10:37:31
  8. * 版本号:      v1.0
  9. * 创建人:        阿乐
  10. *-------------------------------------------------------------------------*/

  11. using System;
  12. using System.Collections.Generic;
  13. using System.Linq;
  14. using System.Text;
  15. using System.Threading.Tasks;

  16. namespace CHigh
  17. {
  18.     internal class _8520
  19.     {
  20.     }
  21. }


虽然单行注释还是需要自己写但是这样感觉很规范
zerorobert 发表于 2023-7-6 10:15 | 显示全部楼层
这个还能自动添加注释的吗              
plsbackup 发表于 2023-7-6 10:35 | 显示全部楼层
这个编码逻辑需要重点说明才行。              
loutin 发表于 2023-7-6 10:40 | 显示全部楼层
总是自己不想写注释,害怕别人不写注释。
primojones 发表于 2023-7-6 10:49 | 显示全部楼层
没有注释的代码可读性太差了。              
abotomson 发表于 2023-7-6 11:14 | 显示全部楼层
VS怎么搭建开发环境呢              
10299823 发表于 2023-7-6 11:20 | 显示全部楼层
如果是没有用过iic,还是软件的好,可以更加深入的理解iic
tabmone 发表于 2023-7-6 11:30 | 显示全部楼层
是否需要下载插件?              
geraldbetty 发表于 2023-7-6 11:39 | 显示全部楼层
自动添加注释是快捷键吗              
您需要登录后才可以回帖 登录 | 注册

本版积分规则

89

主题

1252

帖子

0

粉丝
快速回复 在线客服 返回列表 返回顶部