 |
Today we are releasing new version of CodeIt.Right - build 1.8.09300. This version features complete ASP.NET support, it is compatible with VS2010 Beta 2 (in addition to VS2008, VS2005, VS2003), Add Rule dialog improvements - "Hide Rules in the Profile" and "Quick Search", 10+ new rules including new category "CodingStyle". Those of you who are using CodeIt.Right with very large solutions may know of the memory limitation issue for the tools that live in the Visual Studio address space, aka "Out of Memory" exceptions. You will be excited to know we have addressed the issue in this version by introducing new "Memory Optimization" mode. The "Performance mode" is still on by default since it offers a little faster analysis but CodeIt.Right will offer to switch to the "Memory Optimization" option when you open a large solution or get the dreaded "Out of Memory" exception. You also are free to switch between the options manually. Another change we made - we removed Sealed modifier for all built-in rules. This gives you even easier way to extend and customize existing rules by simply overriding just the methods you wanted changed. See Tutorial: Extending Existing Rules for a sample. This update is free for all users who are current on their Software Assurance and Gold Support Subscription New in CodeIt.Right v1.8:
- Now compatible with VS2010 Beta 2, VS2008, VS2005 and VS2003
- Finally complete ASP.NET support including refactorings in HTML markup.
- Added Memory Optimization mode – allows to minimize the memory use at slightly lower reduces performance. This allows to solve the “Out of Memory” issue on large solutions.
- Added Performance tab to the Options window – Best Performance/Memory Optimization.
- Added new Exclude tab and moved all exclude tabs there
- All Exclude tabs now support multi-select
- New option to Exclude a Project
- Added new “Add” button in Exclude Rule, Exclude File and Exclude Project tabs – the dialogs support multi-select.
- Profile Editor -> Add Rule dialog has new option Hide Rules in the Profile which removes from the selection the rules that already exist in the selected profile.
- Profile Editor -> Add Rule dialog has new Quick Search that filters the list for the rules that contain entered substring
 - Added RuleID to rule help documentation.
- Product license codes when entered are now activated on the SubMain server.
- Auto Update wizard now shows Software Assurance & Gold Support subscription expiration date.
- About window now shows Software Assurance & Gold Support subscription expiration date.
- All web services – Auto Update, Error Reporting, Statistics and Activation – are now accessed over SSL protected HTTPS connection.
- Removed Sealed modifier for all built-in rules. This allows for new easier way to extend and customize existing rules by simply overriding specific methods. See Tutorial: Extending Existing Rules for a sample.
- Addressed issues related to incorrect source file encoding when Byte Order Mark (BOM) attribute was missing.
- New Rules:
- Abstract class should have at least one derive class (Design)
- Interface should have at least one implementation (Design)
- Project should have AssemblyInfo file (Design)
- Do not place assembly attributes outside of AssemblyInfo file (Design)
- Do not include multiple statements on a single line (CodingStyle)
- Avoid single line If statement (CodingStyle)
- Do not check for empty strings using Equals (Performance)
- XML Comments should be spelled correctly (Spelling)
- Avoid non-public fields in ComVisible value types (Interoperability)
- Avoid static members in ComVisible types (Interoperability)
- PInvokes should not be visible (Interoperability)
- Fixed a number of bugs in the application and the rules...
Download
Download version 1.8.09300 here - http://submain.com/download/codeit.right Technorati Tags: CodeIt.Right, Coding Guidelines, Naming Conventions, Best Practices, .NET, NET
As announced earlier today we just closed the acquisition of the popular XML Comment helper tool GhostDoc. We, SubMain, will continue to evolve the tool and distribute it as a free product.
We are also announcing today the availability of the new version of GhostDoc v2.5.09150 which improves the user setup experience, adds support for Visual Studio 2010 Beta 1 and full support for Visual Basic. Additionally, today we are making available a new version of CodeIt.Right (v1.6.09151) that adds the IntelliComment feature based on the GhostDoc algorithm and offers improved and automated generation of XML Comments. We are very excited about taking over the future of an excellent tool such as GhostDoc! We are committed to maintaining this wonderful free tool and we welcome the community feedback and suggestions.
For more on the agreement, please see the press release and interview with Serge Baranovsky and Roland Weigelt - What's in the shop for GhostDoc?
New in GhostDoc v2.5:
- Compatible with VS2010
- Support for VB - GhostDoc now has full support for VB
- Removed "Enable experimental support for VB" option in Settings.
- Improved product setup experience
- Single setup for all supported versions of Visual Studio - VS2005, VS2008 and VS2010.
- Setup will detect older version installed and automatically uninstall it.
- Converted from VS Add-In to VS Package
- Resolved installation issues related to the VS Add-In model - by converting to VS Package
DownloadDownload GhostDoc v2.5.09150 here - http://submain.com/download/ghostdoc
Download CodeIt.Right v1.6.09151 here - http://submain.com/download/codeit.right
As you may know yesterday Microsoft released VS2010 Beta 1 to MSDN Subscribers. The Beta will also be publicly available for the rest of the world on Wednesday. This is long expected and very exciting new version of Visual Studio; and we here at SubMain are fully prepared to support the new shiny version!
While some companies make a big deal posting screenshots of the upcoming VS2010 versions and announcing availability of previews for their products within a month, we at SubMain have been working hard to give our customers a new fully VS2010 compatible version on the day of VS2010 Beta 1 release!
So ... today, within the 24 hours of the VS2010 Beta 1 availability, you can download new version of CodeIt.Right that runs in VS2010 (as well as VS2008, VS2005, VS2003) and fully understands the syntax changes in C# 4.0 and VB10! This is just of the many new features that come with this release - you can see the long list below.
With the VS2010's multi-monitor support and CodeIt.Right allows for even better performance as you keep violations up on one monitor while review source code and the changes on the other monitor.
Another great feature added in this version is the template based rules. We currently support T4 templates. The template based rules are simpler and more flexible alternative to writing custom rules using CodeIt.Right SDK.
Over the next couple of weeks we will be adding a tutorial on how to use and customize T4 templates in CodeIt.Right. Ping us if you want this sooner.
Give it a shot and let us know what you think!
This update is free for all users who are current on their Software Assurance and Gold Support Subscription
New in CodeIt.Right v1.6:
- Compatible with VS2010
- C# 4.0 and VB10 syntax support
- Automatically Implemented Properties (VB.NET)
- Generic Variance (VB.NET)
- Multi-line lambda expressions that can contain statements (VB.NET)
- Implicit line continuation (VB.NET)
- Dynamic lookup (C#) - (the "dynamic" type)
- Named and Optional parameters (C#)
- Covariance and contravariance (C#)
- Added T4 template based rules
- Profile Editor supports editing and validation of T4 templates
- Rule "Externally visible types and members should have XML comments" has been rewritten as a template based rule and is customizable now
- Added Global Properties tab in Options - user configured properties to be used with the T4 templates
- Spell-checking rules
- Significantly improved performance, now suggested spellings lookup is only performed when the the Correction Options dropdown is clicked
- Spell-checking rules - improved performance when use a secondary (non-English) dictionary
- Spell-checking rules - renamed en_US.usr to complang.usr
- Further improved ASP.NET support - rename refactoring now also corrects the ASP.NET page HTML markup server tag IDs and attributes
- Context menus Check All, Clear All and Correct Checked are now context specific when clicked on file or project lines in the violations list
- Improved performance for Check All, Clear All, Exclude Rule and Exclude File
- Analyze Project and Analyze File context menus in the violations list, see forum post
- Analyze Folder and Analyze Project context menus in the Solution Explorer
- Synchronization of the file selected in the Solution Explorer with the violations list
- About dialog - added subscription expiration date
- Added "Don't show this exception again" checkbox to the unhandled exceptions dialog
- Default Encapsulate Field correction for rules "Do not declare externally visible instance fields" and "Secured types should not expose fields" changed from "Create new property and update all references where the field is use" to "Rename the field, create new property with the original field name and do not update the field references" (for the public name has not changed), see forum post
- Added new property ExcludeList to all Naming rules, see forum post
- Added new RuleTargets - Solution, Project, File
- New Rules:
- Use constants where appropriate (Performance)
- Remove unused internal classes (Performance)
- Do not initialize unnecessarily (Performance)
- Source file name should be Pascal cased (General)
- Source file should contain only one public type (General)
- Source file name should match public type name (General)
- Enable Treat Compiler Warnings As Errors option (General)
- Enforce Warning Level 4 (General)
- Source file should have a header (General) - a T4 template based rule
- more bug fixes
Known issues
We are releasing the product with one known issue this time for it is very minor.
- Under VS2010 Beta 1 CodeIt.Right rule documentation links, like "More", "Tell me more..." don't work. This feature depends on the Visual Studio offline help module which was not shipped with VS2010 Beta 1. You still can use Rule Help in the Profile Editor. Rule documentation help works fine in VS2008, VS2005 and VS2003.
Download
Download version 1.6.09139 here - http://submain.com/download/codeit.right
Technorati Tags: CodeIt.Right, Coding Guidelines, Naming Conventions, Best Practices, .NET, NET
With just a couple of days left this year, I wanted to share with you a great article in the MSDN Magazine Toolbox column this month on Improving Software Quality with Static Code Analysis Tools where MS MVP Scott Mitchell is reviewing Static Analysis Tools For .NET. Scott is comparing FxCop, StyleCop and CodeIt.Right:
While FxCop and StyleCop pinpoint rule violations, the developer is still responsible for implementing these tools' suggestions. CodeIt.Right from SubMain takes static code analysis to the next level by enabling rule violations to be automatically refactored into conforming code.
Like FxCop, CodeIt.Right ships with an extensive set of predefined rules, based on the design guidelines document mentioned earlier, with the ability to add custom rules. But CodeIt.Right makes it much easier to create and use custom rules.
CodeIt.Right's biggest benefit is the automatic code refactoring.
Scott summarizes:
Static code analysis tools provide a fast, automated way to ensure that your source code adheres to predefined design and style guidelines. Following such guidelines helps produce more uniform code and also can point out potential security, performance, interoperability, and globalization shortcomings.
Thank you, Scott!
Visit MSDN Magazine web site for the complete article.
What is your experience with CodeIt.Right, please tell us. And, as always, ask questions!
Happy Holidays!
Technorati Tags: CodeIt.Right, Coding Guidelines, Naming Conventions, Best Practices, .NET, NET
Just before the holiday we are releasing new version of CodeIt.Right - build 1.2.08357. Download version 1.2.08357 today!
This release features addition of spell checking engine to CodeIt.Right SDK, workaround for the Out of Memory error on large solutions, 12 new rules and many bugs fixed.
Please share your feedback in the forums especially on the new spell checking rules - we are still working and improving them.
Note: The new spelling rules are included with the built-in profile but they are turned off by default - you will need to turn them on. For all rules you will need to add them into your custom profiles.
This update is free for all users who are current on their Software Assurance and Gold Support Subscription
Major changes in CodeIt.Right v1.2 :
- New feature - Spell Checker, we extended SDK with spell checking engine which enables us to add new rules. This build includes en-US, en-GB, en-CA, en-AU, fr-FR, es-ES, es-MX dictionaries. You can add other languages using OpenOffice format dictionaries. We cannot distribute de-DE and it-IT dictionaries for they are GNU GPL licensed but you can download them from OpenOffice web site here as well as several dozen of other languages.
- Added - Out Of Memory error handling - shows dialog that links to the page with recommendations on How to avoid Out Of Memory exceptions in Visual Studio by enabling is to use up to 3GB of virtual memory
- Added - "Copy Violation" in the violation list allows to copy the highlighted violation information into clipboard. Alternatively use Ctrl+C.
- "Exclude File" violation list context menu option is now enabled when right-clicked on the file name row
- Added - Cache Folder Path option - allows to move CodeIt.Right cache directory (default - User\Application Data)
- New Rules:
- Identifiers Should Be Spelled Correctly (Spelling)
- Comments Should Be Spelled Correctly (Spelling)
- Type link demands require inheritance demands (Security)
- Secured types should not expose fields (Security)
- Secure serialization constructors (Security)
- Review visible event handlers (Security)
- Review deny and permit only usage (Security)
- Review declarative security on value types (Security)
- Method security should be a superset of type (Security)
- Array fields should not be read only (Security)
- Aptca methods should only call aptca methods (Security)
- Wrap vulnerable finally clauses in outer try (Security)
- CodeItRight.Cmd.exe changes:
- many bugs fixed
Download build 1.2.08357 here - http://submain.com/download/codeit.right
Technorati Tags: CodeIt.Right, Coding Guidelines, Naming Conventions, Best Practices, .NET, NET
by Serge Baranovsky
The best and the biggest MS developer conference Microsoft PDC 2008 edition is just few days away. We, of course, wouldn't miss the great opportunity to meet and network with potentially 10000 developers.
This year we will be giving away free CodeIt.Right licenses for those who manage to spot me in the crowd and talk to me about your favorite CodeIt.Right feature, what you don't like about the product or help to prioritize the upcoming features. Or talk about what's important to you, what's on you mind, or just a geek talk.
To help you find me I will share that I'm attending Palermo Party Sunday night and hanging around most every party, event, session and between the sessions. You can follow me on Twitter , email me at sergeb@submain.com or call our toll free line 1 (800) 936-2134 and choose extension 3 - "Talk to Serge" (special PDC option :)
If you have never met in person, perhaps picture on my Twitter account - http://twitter.com/sergeb - will help you :)
Looking forward to meeting you all in LA next week!
Technorati Tags: CodeIt.Right, Coding Guidelines, Naming Conventions, Best Practices, .NET, NET
New version of CodeIt.Right is out! You can download build 1.1.08262 today.
This is a major release even though we only added ".1" to the version. It includes .NET 3.5 support, Guidelines document template generation, option to analyze single file, enhanced SDK documentation, new rules, new command line version parameters and more. Please share your feedback in the forums.
This update is free for all users who are current on their Software Assurance and Gold Support Subscription
Major changes in CodeIt.Right v1.1 :
- Support for .NET 3.5 (C# 3.0 and VB 9.0)
- New feature - Generate Template in Profile Editor allows to generate guidelines document template based on the profile. Please note the XSL stylesheet only works with IE (not Firefox)
- New feature - Analyze File in the Solution Explorer context menu - enables individual source code file analysis
- New feature - Severity Threshold dropdown - allows to quickly filter violations by severity
- Improved Profile Editor layout
- Added "Rule Info" tab in Profile Editor
- Pivot View allows to save your custom views (Save As)
- Updated SDK documentation - now includes most every class, method and property of CodeIt.Right SDK. We will update the Online SDK documentation promptly.
- Auto-Update now also includes the latest help file
- New Options -> General -> Max violations to report (default Unlimited) to limit to the first N violations reported
- New Rules:
- Do not declare read only mutable reference types (Security)
- Seal methods that satisfy private interfaces (Security)
- Secure GetObjectData overrides (Security)
- Assemblies should declare minimum security (Security)
- Override link demands should be identical to base (Security)
- Prefix member calls with self (Usage)
- Do not prefix calls with Base unless needed (Usage)
- Review suppress unmanaged code security usage (Security)
- Do not indirectly expose methods with link demands (Security)
- Security transparent code should not assert (Security)
- Secure asserts (Security)
- Code region name should be PascalCased (Naming)
- CodeItRight.Cmd.exe improvements:
- Added MsBuild and Nant tasks (SubMain.CodeItRight.MSBuild.dll and
SubMain.CodeItRight.NAntBuild.dll)
- Fixed /Quiet option
- Added /OutXSL parameter
- Added /CRData parameter
- Added /severityThreshold parameter
- Improved formatting of the output XML data file
- Added return error codes
- Removed key press required in the older version
- see CodeItRight.Cmd.exe Command Line Options for details
- Removed Alt shortcuts in the toolbar - they were conflicting with some of the Visual Studio
- Renaming a parameter now also updates its name in XML comments
- Added CodeRegion class in the SDK
- Added "Expression" and "Code Region" to Rule targets
- many bugs fixed
Download build 1.1.08262 here - http://submain.com/download/codeit.right
Technorati Tags: CodeIt.Right, Coding Guidelines, Naming Conventions, Best Practices, .NET, NET
by Serge Baranovsky
Earlier this week I attended VSX DevCon on Microsoft campus where I learned quite a bit about the changes coming to the upcoming version of Visual Studio (Dev10) and its Extensibility Model. This was very important for us to be abreast of the future Microsoft releases and stay ahead of the game with our products. I twittered some of the event.
It was fun conference too. I talked to many MS VSX folks, first time saw Rico Mariani talking (he is excellent!), met new people and old friends including Richard Hundhausen, Roy Osherove and Eli Lopian of TypeMock, discussed templating options (something to be included into future version of CodeIt.Right) with T4 guys.
While fun, food and snacks were a little different this time around. There was another conference across the hall and MS catering had naturally setup separate snack tables. Which I didn't really pay much attention to... So when VSX tables got low on snacks I was yelled at by a catering lady for trying to get something from the other conference table. I had a weird feeling of a kid being caught stealing cookies...
Well, the story next day made me feel a little better about my "cookie incident" :) It was mentioned already by Ken Levy via Twitter and Ted Neward on his blog - Steve Ballmer got scolded by catering for taking a cookie without VSIP badge... At least I wasn't the only one who got confused and yelled at ;)
Back to the business now. Me being out of the office for few days didn't affect the progress on v1.1 release of CodeIt.Right. In fact, it is finished, tested and will are releasing it tomorrow.
Stay tuned!
by Serge Baranovsky
New version of CodeIt.Right is almost out. We have a beta build 1.1.08198 for you today. Please download and give it a try, let us know what works and what doesn't. This is pretty big release that includes .NET 3.5 support, Guidelines document template generation, new command line version parameters and more. Please share your feedback in the forums.
If you get an unhandled error dialog, please enter your email address so we could let you know when we resolved the issue or if we need to contact you for more details in our troubleshooting.
For the .NET 3.5 support we have made major changes to our parsing engine - please report all issues you encounter with the Beta.
Major changes in the v1.1 Beta:
- Support for .NET 3.5 (C# 3.0 and VB 9.0)
- New feature - Generate Template in Profile Editor allows to generate guidelines document template based on the profile. Please note the XSL stylesheet only works with IE (not Firefox)
- Improved Profile Editor layout
- Added "Rule Info" tab in Profile Editor
- Pivot View allows to save your custom views (Save As)
- Updated SDK documentation - now includes most every class, method and property of CodeIt.Right SDK
- Auto-Update now also includes the latest help file
- New Options -> General -> Max violations to report (default 1000) to limit to the first N violations reported
- New Rules:
- Do not declare read only mutable reference types (Security)
- Seal methods that satisfy private interfaces (Security)
- Secure GetObjectData overrides (Security)
- Assemblies should declare minimum security (Security)
- Override link demands should be identical to base (Security)
- Prefix member calls with self (Usage)
- Do not prefix calls with Base unless needed (Usage)
- CodeItRight.Cmd.exe improvements:
- Added MsBuild and Nant tasks (SubMain.CodeItRight.MSBuild.dll and
SubMain.CodeItRight.NAntBuild.dll)
- Fixed /Quiet option
- Added /OutXSL parameter
- Added /CRData parameter
- Improved formatting of the output XML data file
- Added return error codes
- Removed key press required in the older version
- see CodeItRight.Cmd.exe Command Line Options for details
- many bugs fixed
Download build 1.1.08198 here - http://submain.com/download.aspx?product=codeit.right-beta
Note: Even though 1.1.08198 is a stable Beta it's Beta nevertheless. Proceed with care.
Technorati Tags: CodeIt.Right, Coding Guidelines, Naming Conventions, Best Practices, .NET, NET
by Serge Baranovsky
As I mentioned earlier I presented CodeIt.Right in Portland at PADNUG last week. I had great time, thank you all guys and girls - you are wonderful and very friendly audience! I'm glad I got to know better some of you during the "informal" meeting at Gustav's after the presentation.
Few of you asked if the slides will be available, so I'm published PDF version of the slides on our community page - PADNUG CodeIt.Right Presentation Slides. If you need the PPT version - just drop me a note at the email address on the first page of the slides.
Thanks again, it was great visiting Portland!
Technorati Tags: CodeIt.Right, Coding Guidelines, Naming Conventions, Best Practices, .NET, NET
by Serge Baranovsky v1.1 progress & Enterprise EditionThe v1.1 release that includes .NET 3.5 syntax has been slightly delayed. There are two reasons for that - we had too much fun at the MVP Summit mid-April and we made few significant changes to the parsing and refactoring engines to support the 3.5 syntax. The coding part is done, we cover all of the .NET 3.5 now. And we are going through a major testing phase as the base application layer responsible for all .NET versions was affected. We are currently targeting end of May for the v1.1 release date.
Meanwhile, the Enterprise Edition of CodeIt.Right is pretty much ready - we should have beta in a couple of weeks. Enterprise Edition has two parts - developer client and Profile Authoring/Admin piece. The latter, in addition to the Profile Editor features, has the ability to push profiles to developer workstations and limit developers to use only the profiles that were published by a Team Lead/Lead Developer/Architect.
Tutorials
We have published CodeIt.Right SDK Online Documentation and a couple of new tutorials: All tutorials are now listed on the new dedicated Tutorials page.
Presentation I will be speaking in Protland at PADNUG this Tuesday, May 6th at 6:30pm - more details here - http://www.padnug.org/padnug/meetings.aspx?ID=145 If you are in the area and want to hear about coding guidelines, best practices, ask questions and see a demo of CodeIt.Right, come join us. I will bring some swag for giveaway, free licenses and discount codes.
Technorati Tags: CodeIt.Right, Coding Guidelines, Naming Conventions, Best Practices, .NET, NET
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
|
|
|
|