Comments in code might not only be some text floating around the functions, variables and classes, but they might contain some extra semantic information. With this improvement, you can navigate through projects much faster or even organize your knowledge. In this blog post, I’ll show you two ways on how to add extra metadata to comments in Visual Studio.
Navigating through a large codebase might be a complicated task. It might be especially an issue when you have big projects (not to mention legacy systems) where logical parts are spread across many different files.
In Visual Studio offers many tools that help with moving between headers, declarations, class hierarchies or all references of a given symbol. But what if you’d like to put a “todo” item? Or some extra note? Such supplementary information can not only help with quick tasks but also might build knowledge about a system.
Here are the things you might want to use to help in Visual Studio
Hashtags (as an extra plugin)
Let’s start with the first one.
Visual Studio contains a feature that enables us to add metadata directly in comments; It’s called Task List. Take a look at this piece of code from my legacy project:
std::vector<Shader *> mShaders; // refactor:
// convert to
// smart pointers!
// todo: implement other special member functions!
As you can see above, I put keywords like refactor: or todo: inside comments.
Visual Studio builds an index of all comments with those special keywords and shows them in a separate window:
This is a handy way of managing simple activities or just taking some small notes for the future. What’s more, the refactor keyword is a custom marker. Visual Studio adds flexibility to set it in the environment settings.
The task list is a nice improvement! The metadata lives inside comments so that other developers can pick up the same information. Still, you cannot easily transfer custom keywords, and the task window offers only basic support. For example, it doesn’t group things (like grouping all of the to-do lines).
Is there anything better?
Hashtags in Visual Assist
For several years I’ve been a happy user of Visual Assist – which is an excellent tool for enhancing various aspects of Visual Studio (have a look at my previous blog posts here or here). The tool also has a powerful feature called Hashtags. This is a combination of named bookmarks, task list and tags that you might know from social networks.
Take a look at the example from my project with extra notes:
/// creates and can build GLSL programs, #shadersSystem
std::vector<Shader *> mShaders; // #refactor
// convert to
// smart pointers
// #refactor #ruleOfZero implement
// other special member functions!
As you can see, this is just regular source code, but please notice those words proceeded with #. I’m using them to mark places that might be worth refactoring. For example, notes about refactoring:
std::vector<Shader *> mShaders; // #refactor
// convert to smart pointers
Or another example:
/// creates and can build GLSL programs, #shadersSystem
This time I’ve used #shadersSystem which groups elements that are crucial to the handling of OpenGL Shaders in my animation application.
Below you can see all of the tags that are displayed in the VA Hashtags window. Similarly to Visual Studio, Visual Assist scans the source code and presents the indexed data.
In the picture above, you can see lots of different tags that I put throughout the code, for example:
#GlutCallbacks – they refer to all callbacks that I passed to the GLUT framework (for my OpenGL Windows Application). With all of the tags grouped under one item, I can quickly move between those functions.
#refactoror #modernize – things to improve later.
Other “notes” that refer to some subsystems like #uiTweaks, #mainLoop and others.
The screenshot also shows a considerable difference compared to the task window. The hashtags are grouped, you can also filter them, or hide according to the project name, directory or even a filename.
Tags are created “on the fly”, there’s no need to predefine them in some configuration window. You just type # and some extra text (you can configure the minimum length of a tag, it’s 3 by default).
Tags are stored directly in the source code, so other developers can immediately see the same information (assuming they also use Visual Assist). Such functionality can be used to create even some simple task manager when you can assign a task by the name of a developer:
// #bartekToDo: please improve this code! don't use goto!
Here are some more things you can do with them
Cross-reference other tags. You can write see:#otherTag and Visual Assist will build an extra list per tag that you can check.
When you type # Visual Assist with autocomplete tags, so you can easily refer to existing hashtags
When you hover over a hashtag in the hashtags window, you’ll see a tooltip with the source code that’s near the tag; this allows to get a better orientation without actually moving to the code.
And many more!
Here’s a great video that summarises the tool:
In this short blog post, I wanted to describe two tools that you can use to add extra information to comments. Having little todo: comments or additional notes can enhance your daily work and build a handy list of actions for the future, or even build up the knowledge about the system.
Depending on your preferences, you can keep those extra notes permanently in your code or just temporarily and gradually move the knowledge and todo actions into external documentation or task manager.
In my daily work, I prefer VA hashtags over regular bookmarks, as they are easier to use in most cases and shows that extra information and structure. You can read more about VA Hashtags on their documentation page: Visual Assist Hashtags.
Back to you
Do you use some extra tools that help you with code navigation?
Do you use Visual Studio task window and task comments?
Have you tried VA hashtags?
This blog was brought to you by Bartlomiej Filipek, you can check out his C++ blog at bfilipek.com
Build 2366 is all about keeping the lights on and letting you code faster and more effectively. While the release includes tons of bug fixes, you’ll find that we’ve added a few new items as well. In keeping with the latest and greatest, we’ve updated to LLVM/Clang 9.0.1. Other notable items include per monitor DPI awareness, Indentation fix for UE4 RIGVM_METHOD() and GENERATED_BODY() macros, and my personal favorite, Open File in Solution is now available during initial solution parse! Check out the full release notes and be sure to download. Remember, maintenance must be current as of 2020.02.20.
While we hope Visual Assist is your favorite dev tool, we know we can’t (and won’t) do everything for you. As we continue developing solutions, we’ll also showcase tools or tips for other problems you may face in other parts of development. This week, you’ll hear from our friends at Ranorex:
How to continue to test in Visual Studio in a post Coded UI world.
Producing powerful on-time releases demands high-quality code and thorough testing. This is why developers have been encouraged to continuously inspect their code for errors and to shift their testing left. Visual studio is far and away the most popular IDE on the planet with an estimated market share of 39%, and there are some great code inspection tools that extend Visual Studio functionality out there, but what about left-shifted test automation?
For users of Visual Studio, Coded UI facilitated a shift-left approach to development by enabling automated UI-driven functional testing from within the IDE. However, earlier this year Microsoft announced that Coded UI was deprecated. Visual Studio 2019 would be the last version to support Coded UI.
Does this mean that left-shifted developers and technical testers are bereft of a testing framework that operates from within Visual Studio? The answer my friends is “not on your nelly”. The Ranorex testing framework provides an API for C# and VB.Net that completely replaces Coded UI.
Migration from Coded UI to the Ranorex testing framework is as easy as one, two, three. Once you have downloaded and installed Ranorex Studio simply follow the instructions below:
1. Create a new Visual Studio project
Open Visual Studio, go to File > New Project. Next, you will need to select .Net Framework 4.5.2 or higher, you will be prompted to choose your programing language, you can select either C# or VB.Net. All that is now left to do in this first step is to select Console Application and hit OK.
2. Add Ranorex core assemblies as references
To ensure a seamless migration away from Coded UI you will next need to add the Ranorex core assemblies. To do so navigate to the project’s Solution Explorer, right mouse click on the References Folder and select Add Reference…
Click browse and then navigate to the Bin folder of your Ranorex installation, (the default location is C:\Program Files (x86)Ranorex Bin).
Add the following:
All Ranorex.Plugin assemblies
Set the Copy Local option to False for all Ranorex assemblies except for Ranorex.Core.Resolver
3. Over to you
Start writing code and continue with left-shifted testing in Visual Studio.
Before you go
Not only are you able to continue to test in your preferred IDE you can also benefit from the best object recognition on the market. Ranorex Spy is the tool developers and technical testers love. Use it to analyze your AUT, its element structure, available object properties and attributes, and build the most robust and reliable XPaths for use in Visual Studio.
Be in full control of your XPaths. Increase or decrease dynamism in line with the complexity your tests require. Add variables to your XPaths and customize how you uniquely identify UI elements even when testing mixed technology applications.
You can also benefit from all the functionality associated with Ranorex. Have a better understanding of failed tests with fully customizable reports. Get built-in object repository access and organize your tests in logical hierarchical structures.
Left-shifted developers and technical testers who have used Coded UI need not mourn its passing, rather they should see the deprecation as an opportunity to increase the speed and quality of their releases. The Ranorex testing framework offers an API that completely replaces Coded UI, has far superior object recognition, and increased functionality. But don’t take my word for it download you full featured 30-day free trial and find out for yourself.
New Year, New Build! Welcome to 2020 and 2358. This release was driven largely to fix an issue with our licensing server and some corruption that may have been experienced by Unity users, but why stop there?
NEW Added C++ modernization refactoring: Convert Unscoped Enum to Scoped Enum (execute on the enum definition). See the documentation.
NEW Goto Related now allows hopping between *_Implementation and *_Validate implementations in UE4.
FIX Goto from a method declaration will now list *_Validate as a target in UE4.
NEW Added option (on the Goto page of Visual Assist Options dialog) to prefer implementations when executing Goto (Alt+G) (execution on the implementation will continue to go to the declaration as before).
Take a look at the full list of features and bug fixes here. And of course be sure to update!
Whether you’re new to Visual Assist and UE4 or a seasoned vet, we thought you might appreciate a little more insight into what you can expect and how to get started. Thanks to our resident UE4 wizards for putting this together.
Visual Assist will come alive after it finishes parsing.
3. Look around
Open the Extensions > VAssistX menu. You will use the menu primarily to open tool windows, review keyboard shortcuts, and access the options dialog.
Appreciate the understated UI to Visual Assist. There are just a few visible changes.
4. Change a few settings
If you like meaningful syntax coloring, open the options dialog for Visual Assist and apply coloring to more of the UI.
If you highlight the current line, choose a thin frame that doesn’t obscure your code.
Visual Assist can add important information to tooltips when hovering over a symbol, such as comments from base classes. This is very helpful in UE4, as base class comments are the documentation.
Visual Assist can analyze your code and suggest improvements. Enable Code Inspections to see blue underlines where code might be improved. Visual Assist can even modernize your code for you! We will show how later.
Then, open the options dialog to Visual Studio and eliminate the redundant navigation bar. The version in Visual Assist includes the functionality of the built-in one.
After making the changes, Visual Studio is ready to use.
5. Navigation in UE4
Search for and open files using Alt + Shift + O. Precede a search filter with a hyphen to exclude symbols (negative filtering).
Understand and navigate the inheritance hierarchies of UE4 by using Alt + Shift + G on a class name. The Alt + Shift + G shortcut works on many types of symbols, try using it on a virtual method.
Source files in UE4 can be thousands of lines long. Use Alt + M to search for and navigate to methods inside the current file.
Find references to a symbol using Alt + Shift + F. Visual Assist’s find references is fast and accurate inside huge solutions like UE4. Try cloning your results to save them by clicking the Clone Results button or using the right-click menu.
Hover over a virtual method to see comments from base classes. Base class comments often contain useful documentation.
6. Refactoring in UE4
Access refactoring tools using the keyboard shortcut Alt + Shift + Q, or by hovering over a symbol and clicking the tomato icon that appears. The contents of the Alt + Shift + Q menu depend on the symbol.
It is common in UE4 to override virtual methods, such as Tick or SetupPlayerInputComponent. Visual Assist can implement these methods for you. Click on your class name and then use Alt + Shift + Q.
The Implement Methods dialog is searchable, and you can implement more than one method at once.
Visual Assist will intelligently add a call to the Super class version of the method for you when appropriate.
You will see blue underlines below code which could be modernized. This is Code Inspection.
Visual Assist can refactor the code for you! Use Alt + Shift + Q on the underlined symbol.
If you need to change the return type, parameters, or the name of a method you can use Change Signature. Edit the method definition in the window. References and call-sites to the method will be updated, so you won’t miss anything.
There is a lot of special functionality built into Visual Assist for UE4, such as suggestions for U* macros. The more you can use Visual Assist, the more opportunities to make your life a little easier in UE4.
You may find the built in IntelliSense to be unusably slow, or that it often adds red underlines to correct code in UE4. IntelliSense can be disabled. Visual Assist provides all the intelligent tooling expected in a modern C++ development environment.
You can throttle the initial parse in the Performance tab of the Visual Assist options dialog. By default, the one-time parse uses all available resources to finish as fast as possible.
If you follow our blog, you’ve seen the features that our team is putting in place and likely felt their impact in your development. Instead of hearing more of the same, we thought we would share thoughts from one of our users. Meet Distalsoft, two brothers, one who can’t stop gaming and one with ideas. We’re not sure which one wrote this post, but either way check them out when you want to hunt for treasure or lose it all attempting Brexit.
C++ with Visual Assist, Visual Studio and Unreal Engine
It’s inspiring that software like Microsoft’s Visual Studio IDE and Epic’s Unreal Engine have been “free” for so long now. It pains me to think about where indie developers would be without the forward thinking force of these larger companies and their seemingly never-ending generosity. Helping start-ups and the like to get their feet on the ground is something I will forever be grateful for.
Although the tools come close to it, it would be naive to think that they can fulfil the job of every requirement. I want to point out a few problems we were facing at Distalsoft when it came to developing in Visual Studio using Unreal Engine and the solution we ended up going with.
Unreal Engine at its core uses the C++ language. Visual Studio – being a Microsoft product – makes development in C# very enjoyable. On the other hand, development in C++ has been a point of frustration for many years. From VS 2010 to VS 2017, improvements have been made to the overall speed of compilation, Intellisense, file searching and the like, but it has taken until 2019 for them to really make a dent in the problem. I must say that VS 2019 has done an excellent job of addressing the aforementioned issues but the question still stands – could it be better?.
A few years ago when I was using VS 2015, I’d had enough. I’d sometimes be waiting several minutes for Intellisense to bring back a list of methods or properties that belonged to an object. I’m pretty sure we’ve all done it – smashing the heck out of the ctrl+shift+space keys and cursing at the screen while waiting for the Intellisense to pop up. Or simple searches in the solution explorer that end up taking longer to resolve than simply finding the file yourself. Perhaps even trying to navigate to the definition of a method only to be waiting minutes for the document to load up. Something had to change. I went searching on the internet for a solution. It didn’t take long to stumble across a piece of software called Visual Assist by Whole Tomato. It had been recommended many times on various parts of the AnswerHub forum for Unreal Engine and StackOverflow. Due to it having a trial version, I downloaded a copy to give it a try.
The expression “night and day”, really doesn’t do the software justice but it’ll have to do for now. I was extremely relieved. Searching for files, definitions, even just including header files were now as you would expect from an IDE. The additional dialog menu that is available when right clicking on bits of code you want to perform actions against, has a variety of options that make you realise what was/is missing from the ootb VS. To be honest, I don’t use half of them, but it’s the baseline mechanics that just work so much better. And, to address my biggest issue – the speed of Intellisense – type-ahead now loaded within seconds and sometimes even instantly. What a relief!
Unreal Engine have improved their documentation, but unfortunately it’s still not quite there. I would always see people answer questions in AnswerHub with “Look through the Unreal Engine code, it’s open source”. I always assumed they were joking. Pressing F12 to go to method definitions without Visual Assist would take forever. Thanks to my new found friend Visual Assist, I finally had the ability to go find the answers to some of the most annoying questions. It’s hard to really communicate just how irritating it used to be. Seriously, Visual Assist has made me a happy C++ coder again.
I suppose the last thing to make note of is that Visual Assist is not currently free, but the trial is sufficient to make you realise just how much happier you can be when using it. I would be interested to see Visual Assist introduce a subscription based payment plan, but you can’t complain. They have done a stellar job at creating a brilliant tool.