Today we released CodeIt.Right v2.2 - new version that adds introduces 23 new rules – Usage and Asynchronous programming best practices – as well as new feature allowing to output analysis results to Visual Studio Error List in addition or instead of CodeIt.Right Violations Report. Here is high level list of new features:

• Added 12 new Async Best Practice Rules
  • Call Start on the Task object before instantiating
  • Async method should have "Async" suffix
  • Async method should return Task or Task<t>
  • Avoid "out" and "ref" parameters in async method
  • TAP method parameters should be the same
  • Do not create async Sub method
  • Transform simple async method to non-async
  • Async method should have await statement
  • Await statement method should be async
  • Do not use Task.Yield in async method
  • Do not use Task.Wait in async method
• Added 11 new Usage Rules
  • Avoid empty methods
  • Avoid System.Console "Write()" or "WriteLine()"
  • Do not explicitly call "System.GC.Collect()" or "System.GC.Collect(int)"
  • Lock both when either set or get is locked for a property
  • Close database connections in "finally" block
  • Avoid control statements with empty bodies
  • Provide "default:" for each "switch" statement
  • Always provide names for threads
  • Avoid use of "new" keyword for hiding methods
  • Always close SQL resources
• New Show violations in Error List feature- now OnDemand analysis results within Visual Studio can be rendered into Violations Report, VS Error List or both
• and more

CodeIt.Right v2.2 has many more features and improvements. For detailed list please see What’s New in CodeIt.Right v2.2

How do I try it?

Download the CodeIt.Right v2.2 at http://submain.com/download/codeit.right/

The .5 release of GhostDoc builds up on the version 4.0 features offering more flexibility for spell checking and help file generation. Most significant changes in v4.5 are:

• (Pro) New Template Libraries feature with Export/Import
• (Pro) New output formats for generated Help files
  • Html Help1 (.CHM)
  • MS Help 2 (.HxS)
  • MS Help Viewer aka MS Help 3 (.MSHC)
  • Website (HTML, ASP.NET, PHP)
• (Pro) Options Dialog: solution specific settings for Ignore lists, Solution Dictionary and Help File, User Dictionary
• (Pro) Added Spelling suggestions window to replace SmartTag. The older SmartTag option can be turned back on in the Options
• (Pro) Custom tag support in Preview Comments and Build Help File
• (Pro) AllMembers, Methods, Properties, Events, Fields, Operators sections to the generated Help file
• Combined arguments of the same exception type into tag text
• Help file/Preview now renders correct project language
• Added syntax highlighting of the blocks in Help File/Preview
• Added "Send Feedback..." to enable easy way of providing feedback right from the product menu

For complete list of v4.5 changes see What's New in GhostDoc and GhostDoc Pro v4.5

Template Libraries

While GhostDoc Pro T4 template mechanism provides maximum flexibility how you can tweak and reconfigure your XML Comments and even regular comments, until now there was no easy way to share the set of templates with your team or the community.

Today we are introducing Template Libraries - you can Export the whole set of your custom templates and distribute it as one file which can be imported. Template Library includes meta-data - the library author, company name and contact information. To access the feature use Options -> Rules -> Export.

We will be hosting a section on our web site where we publish GhostDoc Pro Template Libraries we release. If you have specific comment formats you want us to release, send your requests in.

We also want to encourage sharing your templates with the community. Contact us if you have template library you was us to publish.

New Help File Formats and Options

When we introduced a simple single click way of generating help file from your project XML comments, we realized that just one CHM format is not enough and we would need to add options to tweak your help file output.

Today GhostDoc Pro can build into the following help file formats:

• Html Help1 (.CHM)
• MS Help 2 (.HxS)
• MS Help Viewer aka MS Help 3 (.MSHC)
• Website (HTML, ASP.NET, PHP)

You also have the following options when building help file with GhostDoc Pro:

• Select solution projects that you want to be included into the help file
• Define Header and Footer for the help file pages
• Decide whether you want to include Private, Internal, Protected members

How do I try it?

Download v4.5 at http://submain.com/download/ghostdoc/

Note to GhostDoc Pro v3 users: Your v3 license won’t work with v4. We will be sending new license codes shortly to those of you with License Protection.

We are happy to announce the release of GhostDoc v4 and GhostDoc Pro v4 aligned with Visual Studio 2012 release as part of our VS2012 sim-ship commitment!

Version 4 is a major milestone for us with great new features and rewrites that we have done over the last year. Here are the most significant additions to the GhostDoc feature set:

• Visual Studio 2012 support
• (Pro) Source code Spell Checker
• C/C++ language support
• XML Comment Preview
• (Pro) Build Help File
• StyleCop Compliance – comments generated by GhostDoc are now pass StyleCop validation
• Exception Documentation - exceptions raised within a method are documented in the XML Comment
• (Pro) File Header menu and template
• (Pro) Visual Studio toolbar with commands for documenting, comment preview and spell-checking
• (Pro) Options -> Global Properties - allows to reference custom configured user properties within T4 templates (CodeIt.Right users will find this very familiar)
• (Pro) IntelliSense in the T4 template editor
• Version update notification – you won’t miss new version release ever again!

For detailed list of v4 changes see What's New in GhostDoc and GhostDoc Pro v4.0

Spell Checker

GhostDoc Pro Spell Checker features:

• Check Spelling as you type
• Spell Checking for XML Comments
• Spell Checking for code elements
• Spell Checking for strings and comments
• Spelling SmartTag in the VS Code Editor
• Added support for OpenOffice dictionaries and multiple languages
• Ignore files and file extensions
• Custom User Dictionary
• Custom Dictionary by Solution
• Solution wide Spelling Report
• Check Spelling for
  • Active Document
  • Selected Documents
  • Current Project
  • Entire Solution

Comment Preview

Do you want to see how your XML Comment will look like in the help file? Have HTML tags encoded in the XML Comment and want to make sure your HTML is correct? GhostDoc Comment Preview is here to help!

How do I try it?

Download v4 at http://submain.com/download/ghostdoc/

Note to Beta testers: We appreciate your contribution to this release and we will be contacting shortly those of you who provided feedback during the alpha/beta testing program.

Note to GhostDoc Pro v3 users: We have changed licensing schema in v4.0 and your v3.x license codes won't work with v4.0. For users with License Protection we will be sending v4.x license codes shortly. Users without the License Protection have to purchase new version - currently we are not offering upgrade path other than the License Protection program.

We posted earlier that on 2/29 when Microsoft announced the Visual Studio 11 Beta, SubMain was one of the first partners with CodeIt.Right product that provided full support for the new VS Beta. We currently are running private Beta program for our GhostDoc product that is also VS11 Beta compatible.

We are happy to announce that SubMain is one of the partners to sim-ship (Simultaneously Ship) our products together with the Visual Studio 11 RTM! You will be able to enjoy fully compatible version of our products when you install Visual Studio 11 on the release day!

In the meantime you are welcome to test drive CodeIt.Right and GhostDoc together with Visual Studio 11 Beta:

We are excited to announce the release of CodeIt.Right v2.0 - new major version that takes our code quality product to the whole new level. This version introduces new major feature – Instant Code Review – that enables developers to get code quality feedback in real time as they type and refactor code smells right at their introduction. We also added new Personal Edition of the product. Here is the high level new feature list:

• Instant Code Review feature – get code quality feedback as you code and refactor on the spot!
• Visual Studio 11 support
• Multiple categories for a rule
• Multi-select in Violations Report
• XAML Parser
• 8 new Silverlight/WPF/XAML rules
• 27 new ASP.NET/Security rules
• Profile Editor - filter for selected/unselected rules
• Option to require comments when excluding code issue
• and more

Focus on coding – we will help you with quality

If you love the CodeIt.Right code quality rules and auto-corrections but want immediate feedback as you code, the new Instant Review feature is for you!

Instant Review allows to run select set of rules in the background and get real-time code issues feedback to developers in the Visual Studio Editor. The feature highlights in the editor code elements that triggered violation and shows complete list of file code issues in the right violations bar (next to the scrollbar). Violation detail window explains the nature of the issue, offers auto-refactoring options and option to ignore (exclude) the violation. The feature can be turned on/off with a single click, supports multiple user configurable profiles that can be switched in the toolbar or right margin violations bar context menu.

Personal Edition

Starting version 2.0 in addition to Standard and Enterprise editions we are offering new Personal Edition designed for solo developers and freelancers. This edition is priced appropriately for personal use – this is the most affordable edition of CodeIt.Right. With introduction of the new edition, price of the Standard has been adjusted.

Is that it?

CodeIt.Right v2.0 has many more features and improvements. For detailed list please see What’s New in CodeIt.Right v2.0

How do I try it?

Download the CodeIt.Right v2.0 at http://submain.com/download/codeit.right/

Note to current users – we have changed licensing schema in v2.0 and your v1.x license codes won’t work with v2.0. For users whose Software Assurance is up-to-date we will be sending v2.x license codes shortly. Users without subscription and those whose subscription lapsed will have the opportunity to purchase new version at the upgrade price.

Note to current Standard Edition users – in version 2.0 we have added "Standard" edition name to all folder locations (Program Files, My Documents, etc) and registry keys. When you install v2.0 Beta you will need to copy your custom profiles and rules into the new folders.

As part of the Visual Studio Industry Partner (VSIP) program we have released VS11 Beta compatible version of CodeIt.Right on the ComponentSource website that hosts VS11 Beta Bundle products. And we are very proud that our flagship product is one of the very first VS11 compatible products available as part of the VS11 Beta Bundle on the day of VS11 Beta launch – February 29, 2012!

Please follow the instructions below to receive the virtual bundle of CodeIt.Right and Visual Studio 11 Beta:

1. Go to the Visual Studio 11 Beta download site to get the newest version of Visual Studio
2. After installing Visual Studio 11 Beta, download CodeIt.Right unpack the zip file and run the installer
   

We released TestMatrix v3.1 which adds support for xUnit testing framework, code editor Smart Tags, better VS2010 integration, command line version enhancements and other improvements.

What's new in TestMatrix v3.1:

• Added support for xUnit testing framework
• Added code editor Smart Tags to run/debug test or group of tests
• Added test result "paintings" in VS2010 editor which were omitted in the first VS2010 compatible release and now they are back.
• Added a "No Coverage" warning in the command line version against project/solution with configuration set to Release
• Added Status message to display test execution status - current test name, current test number and total number of tests - "Running test N of NN (<test name>)"
• Implemented a number of Test Results Window enhancements
• TestMatrix now uses currently selected in Visual Studio build configuration including CPU
• Added "Don't show this again" checkbox to the "Are you sure?" dialog when stopping test execution
• Fixed - TestMatrix was ignoring TestCaseData objects with names assigned
• Improved support for TestFixtureSetUp
• Implemented correct TestContext handling within MsTest unit test execution
• Added command line parameter /failThreshold to stop a build (return error code) if number of failed tests is higher than the threshold
• Added command line parameter /configuration to specify build configuration, for example, "Debug|AnyCPU"
• Changed Options file format from binary to XML
• Added offline license activation option for users behind strict firewalls
• Added option to request product trial extension

TestMatrix build 3.1.11190 is available for download at http://submain.com/download/testmatrix/

Note to current users, due to the introduction of offline license activation mechanism your v3.x license code needs to be re-activated. This is done simply by re-entering your registration details in the "Enter License Key..." menu.

Version 3.1 is a free update for all TestMatrix v3.0 users. Users with v2.x licenses are eligible for upgrade price of $99 per license. Please contact sales@submain.com with your license information for the upgrade details.

by Serge Baranovsky

This CodeIt.Right rule update includes fixes as well as 3 new security rules.

New rules:

• Do not declare read only mutable reference types (Security)
• Seal methods that satisfy private interfaces (Security)
• Secure GetObjectData overrides (Security)

These rules are included with the default profile and you will only need to follow the wizard to merge them into your custom profiles.

Fixes:

• Rule "Do not override operator equals on reference types" incorrectly triggered violation for the "Equals" method. Now this rules only reports violation for the operator "==" override.
• Fixed "If the type is a generic type, CIR adds the apostrophe-count string to the class name for the deserialization constructor"
• Fixed "If there is no explicit default parameterless constructor, adding the deserialization constructor causes errors in all derived classes that called the parameterless constructor"

As a reminder, this set of rules is distributed using the Rule AutoUpdate feature which triggers 15 minutes after you start Visual Studio. If you turned the feature off, you can manually start the update wizard from the CodeIt.Right/Help & Support/Update Rules menu.

Technorati Tags: CodeIt.Right, Coding Guidelines, Naming Conventions, Best Practices, .NET, NET

by Serge Baranovsky

Mike McIntyre posted great review of CodeIt.Right on DevCity.NET - http://www.devcity.net/Articles/348/CodeIt.Right.Review.aspx - Mike has put CodeIt.Right through a test using 10 of his projects.

Mike summarizes:

I feel CodeIt.Right's features for configurable static code analysis and its ability to automatically correct my code make it well worth the purchase price. It has become and indispensable addition to my developer toolkit.

I highly recommend you give it a try.

Thank you Mike!

What is your experience with CodeIt.Right? Feel free to ask questions, tell us what you think!

Technorati Tags: CodeIt.Right, Coding Guidelines, Naming Conventions, Best Practices, .NET, NET

by Serge Baranovsky

We obtained exclusive distribution rights to the latest version of Steve Sartain's C#/VB .NET Coding Guidelines 100+ page ebook, and are offering free download from our website. From now on we will be maintaining the guidelines along with the author.

Topics covered in C#/VB .NET Coding Guidelines include:

• Naming Guidelines
• Class Member Usage Guidelines
• Guidelines for Exposing Functionality to COM
• Error Raising & Handling Guidelines
• Array Usage Guidelines
• Operator Overloading Usage Guidelines
• Guidelines for Casting Types
• Common Design Patterns
• Callback Function Usage
• Time-Out Usage
• Security in Class Libraries
• Threading Design Guidelines
• Formatting Standards
• Commenting Code
• Code Reviews
• Additional Notes for VB .NET Developers

Here is what Andrew Sutton says about the ebook at vbCity: "Steve Sartain has come up with a very readable document that offers comprehensive guidelines for structuring code writing."

Better hurry up to download this excellent whitepaper on coding guidelines and best practices while supplies last! (Just kidding, our supplies of this electronic downloadable book are unlimited )

Technorati Tags: CodeIt.Right, Coding Guidelines, Naming Conventions, Best Practices, .NET, NET