Tutorials & How To
-
|
Introduction CodeIt.Right Enterprise Edition installation package includes two modules for you to choose from - Team Configuration Module and Analysis Module. The Team Configuration Module ( TCM ) is tailored for Team Leads and Architects. With this module...
|
-
|
Step 1: Reference the Image from within the XML Comment You can use standard HTML syntax to insert the link to an image inside the comment. C# /// <summary> /// The ClassLibrary22.One namespace. /// </summary> namespace ClassLibrary22.One...
|
-
|
Introduction In our earlier tutorial we describe the basic steps needed to create conceptual content in your Help files. It covers topics such as descriptions of the various file types you'll need to know about and how the conceptual content should be...
|
-
|
Introduction In an earlier tutorial I demonstrated the basic components used to create conceptual content . That tutorial also explained the basic building blocks, including the file types used and also how the conceptual content should be structured...
|
-
|
If Visual Studio Crashes While You're Using One of SubMain Add-Ins Even though we put a huge amount of time and resources into getting our products right, things can still sometimes go wrong. If you've experienced a Visual Studio crash while using one...
|
-
|
Table of Content Introduction The ClassLibrary1 Sample Project Summary of the Files Used to Create Conceptual Content Content Layout File - ClassLibrary1.content Topic Files Welcome.aml CodeSnippetsFile.aml Tutorial Topic Custom Page Topic Custom Node...
|
-
|
You can integrate CodeIt.Right with TeamCity by following these steps: 1. Download and install the CodeIt.Right Enterprise Edition. Note that this integration only works with the Enterprise version of CodeIt.Right. 2. Navigate to the directory where you...
|
-
|
Using the Enterprise edition, CodeIt.Right integrates seamlessly into your Source Control procedures, letting you scan files, highlight issues or violations, and fix them before check-in. Because you can test the code against any configured profile, you...
|
-
|
Introduction Note : if you would like to get quick four minute overview of the key GhostDoc features before proceeding with the evaluation guide below, you can view this video . Once you've downloaded and installed GhostDoc Pro, you can access its features...
|
-
|
While CodeIt.Right comes with a great number of ways to ignore (exclude) violation, rule, file, project, etc, it also supports the SuppressMessage route. In this post you will find sample syntax for SuppressMessage attribute. You will find that CodeIt.Right...
|
-
|
(This post is slightly edited version of the Introduction page in GhostDoc Help file) What does GhostDoc do? GhostDoc installs a new command - "Document This" into Visual Studio code editor context menu. When editing a source file, you simply...
|
-
|
The biggest benefit of CodeIt.Right is the automatic code correction and refactoring to patterns. The alternative is you could manually spend hours or even days on some pesky violations rather CodeIt.Right do the work for you in a matter of minutes. You...
|
-
|
One of the very helpful and important rules that we added in the past few months is the one that finds members that missing XML documents when these are required - General / Type, Member -> Should have XML comments ( Externally visible types and members...
|
-
|
You already know how you can create new custom rules using CodeIt.Right SDK , of not, you may want to read this article first. In this tutorial we will show how to extend existing rules using the new SDK features introduced in CodeIt.Right v1.8.09300...
|
-
|
Sometimes you may reset default GhostDoc shortcut in Visual Studio or want to assign your own custom shortcut. Here is how you do that: In Visual Studio go to Tools -> Options , then select Environment -> Keyboard Filter commands by "GhostDoc"...
|
-
|
If you need to preserve your Visual Studio settings, there is a tool built into VS that allows to backup and restore the settings. In this tutorial we are assuming that you are saving a copy of ALL settings to use by you personally as a backup. Make a...
|
-
|
CodeIt.Right Log file contains detailed debug information that allows us to troubleshoot most every issue on you experience with the product. These are the steps to email the log file to us: Open Visual Studio In the menu bar, click CodeIt.Right , then...
|
-
|
CodeItRight.Cmd is the command-line companion to the CodeIt.Right application. Like CodeIt.Right, CodeItRight.Cmd analyzes source code and reports violations, such as possible design, performance, and security issues. CodeItRight.Cmd can be used as a...
|
-
|
Revised and amended February 20, 2014 CodeIt.Right ships with a wide range of rule libraries included, but the great thing is that you are not limited to just those. You can extend the range by doing any or all of the following: Customize your own rule...
|
-
|
Some of the rules included with CodeIt.Right are not part of the built-in profile as are not part of the Microsoft Guidelines and yet they often come very handy especially when you choose to use a standard other than recommended by Microsoft. This post...
|
-
|
If you try to edit the built-in Profiles in CodeIt.Right you will get a message saying that the profile is read only. This is done to ensure the integrity of the default guidelines that ship with CodeIt.Right. These two profiles – the Microsoft Guidelines...
|
|
|
|
|