Visual Assist
是一款非常好的Visual Studio
下开发的插件,网上已经有很多关于它的配置以及相关介绍,本文不再赘述。本文将注重介绍它的Hashtags功能。
本文主要内容来自于官网介绍,感兴趣的朋友可以参考官方链接。
Hashtags简介
Hashtags
功能是命名书签和任务管理的功能结合,它能实现有效导航和代码任务管理。它的表现形式为带‘#‘字符的注释语句,形如 // #comment
。使用时有以下两点注意:
- hashtags可以出现在注释的任何位置,一个注释可以包含多个hashtags
- hashtags内容与#号之间不能有空格
- hashtags内容的长度要大于6,太短的内容不会被识别,长度可配置
- hashtags内容是大小写不敏感, #main 和 #MAIN 会被识别为两个tag。
以下为一个简单的使用例子:
// #main
main()
{
do_work();
}
在Visual Assist中的VA Hashtags窗口中,可见如下记录:
不像VS自带的匿名书签,VA Hashtags是保存在注释中的,一旦提交到代码库,这些tags可以被团队成员看到,这可促成在团队中分享业务知识,提高团队效率。
导航工具
除了程序入口定义 #main 之外,它也可用在类名定义和重点功能描述上,例如 #ClassName,#DescriptiveNameOfThing。
你也可以用它来给程序中性能瓶颈(#bottleneck)地方打上标签, 非线程安全(#threadUnsafe)或者针对特定版本开发的函数(#apiVersion)打上标签。
你可以在多处使用同一个hashtag,这表明这几处代码同属于一个主题,可使用GoToImplementataion
来在同一个主题的不同位置处进行跳转。
已经编辑好的Hashtags会加入到建议列表和自动完成列表中。
任务管理
在短期需要需要指派的代码任务,可通过Hashtag指定负责人。例如:
// #MaryFixForNextBuild dosomething() crashe when given a negative value
VA Hashtags管理窗口提供搜索功能,该窗口自动刷新,无需开发者显式的创建和删除tags。Hashtags管理窗口提供按文件分组和按tag分组两种显示模式,方便用户切换使用。Hashtags管理窗口右键提供隐藏功能,可按需显示tag。
配置
可在VA配置VA Hashtags
进行更多细节配置,例如是否支持连字符、十六机制字符串、hashtag的最小字符长度等。
一些现有代码中的注释中的内容,会被VA Hashtags
解析为Tags标签,这混淆了注释和标注,这一点在使用时,需要注意。
小结
笔者认为,HashTag作为导航增强工具,比VS原生书签有很多优秀的地方,可将业务代码梳理经验和结果共享给团队成员,建议在团队成员中推广。而作为任务管理工具时,它的功能以及表现有点弱,不建议将任务管理和代码本身混合在一起,推荐使用JIRA等更强大的任务管理工具。
原文地址:https://www.cnblogs.com/cherishui/p/11991626.html