/Community

Sometimes you may reset default GhostDoc shortcut in Visual Studio or want to assign your own custom shortcut.

Here is how you do that:

1. In Visual Studio go to Tools -> Options, then select Environment -> Keyboard
   
2. Filter commands by "GhostDoc" in the Show commands containing text box
   
3. Select Tools.SubMain.GhostDoc.DocumentThis in the list
   
4. Select "Text Editor" in the Use new shortcut in drop down
   
5. Choose the hotkey you want to invoke the DocumentThis command (Ctrl+Shift+D in this example)
   
6. Press Assign and OK to close the dialog and save. You are all set.

While you are in the Options dialog you may want also assign shortcut to another less known but very useful GhostDoc command Rebuild Documentation. This command will rebuild your existing XML comment using the changed signature information. Be careful with this command though - it will reset your custom edited XML comment. In the example below we assigned command RebuildDocumentation to sequence Ctrl+Shift+D, Ctrl+Shift+R

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:

1. Open Visual Studio
   
   
2. In the menu bar, click CodeIt.Right, then click Help & Support, and then click Email Log File
   
   
   
   
   
3. Attach file from the location in the email body - in the screenshot above is "C:\Users\sergeb\Documents\SubMain\CodeIt.Right for VS2008\CodeIt.Right.log"
   
   
4. Click Send to email the attached file to us.

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 Profile and the SubMain Instant Review Profile - are included to give you examples of the kind of rules you might want to create and apply as your own team standards.

You can configure the shipped rules so that they fit your specific needs or create new ones. You can rearrange the rule groups and you may even decide to group certain sets of rules into completely separate profiles.  For example you may decide to group all security related requirements into a security rules profile. You can run this profile as needed as part of the On Demand analysis.  Alternatively, you can use this - or any – profile as an Instant Review profile that runs in the background when working on a particular project.  The bottom line is that you can use the power of CodeIt.Right, in this case the Profiles feature, to have the product work in just the way you want.

You can create your own customized CodeIt.Right profiles either by cloning an existing profile or creating your own from scratch.  This tutorial explains both ways of doing this.

Cloning an Existing Profile

1. Open the Profile Editor
   
   
   
2. Click the Save As toolbar button
   
   
   
3. Enter a name and (optional) description for your profile
   
   
   
4. The newly created profile will be opened in the Profile Editor ready for you add, edit or delete items of your choice.

Creating a New Profile from Scratch

To create a new profile from scratch, do the following:

1. Open the Profile Editor
   
   
   
2. Click the New button on the toolbar
   
   
   
3. Enter the name and (optional) description for your profile. Next, in the Base Profile combo box, select Blank. You can then add the rules you want in your custom profile.