|
|
 |
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 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
by Serge Baranovsky
Since the v1.0 release a number of improvements were requested for use CodeIt.Right in an automated build process and we are making a refresh for CodeItRight.Cmd.exe available today. This version of CodeItRight.Cmd will be included as part of the v1.1 release which additionally will ship with ready to use tasks for MSBuild and NAnt.
See CodeItRight.Cmd.exe Command Line Options for complete list of the console version command line switches and error codes.
Important:
- This copy of the console version of CodeIt.Right will only work with the original v1.0 release (build 1.0.08035)
- It will only work with the VS2005 and VS2008 version of CodeIt.Right. If you need VS2003 version, please contact support.
You can download the new improved here
Instructions:
- Extract SubMain.CodeItRight.Cmd.exe from the downloaded zip file
- Save it to CodeIt.Right program directory, typically Program Files\SubMain\CodeIt.Right
Changes in this build of CodeItRight.Cmd.exe:
- Fixed /Quiet option
- Removed key press required in the older version after it is done analyzing solution
- Added /OutXSL parameter
- Added /CRData parameter
- Improved output XML data formatting
- Added return error codes
See CodeItRight.Cmd.exe Command Line Options for complete list of the console version command line switches and error codes.
by Serge Baranovsky
CodeIt.Right is finally finished after about 3 years in the making. That's right, CodeIt.Right is Released! It is out in its all new shiny package :)
I would like to make a pause here and extend my deepest gratitude towards everyone who helped make this release possible. From the SubMain development team, the advisory board members, to everyone who participated in the community and contributed feedback over the year since we released the first public beta.
CodeIt.Right, my 7 years long dream come true. The tool it out! Cheers! (I truly believe that code analysis coupled with automatic refactoring will change the way .NET developer teams and solo developers work!)
With the touchy-feely stuff out of the way, let's get back to the actual product, shall we? :)
If you are new to CodeIt.Right:
What's next?
This not a road map per se, just highlights of where we are heading with CodeIt.Right over the next months:
- We will keep publishing new rules as they are developed and will push them to you using the Auto-Update feature
- We will publish more tutorials and how tos on using the product and developing your own custom rules using CodeIt.Right SDK
- Create community section over at http://community.submain.com and allow custom developed rules shared with other users
- Version v1.1 is coming in 4-6 weeks - .NET 3.5 syntax, merging profiles, Pivot View improvements, generating team guidelines document template from profile, and of course, more rules!
- Version v2.0 is preliminarily scheduled for summer 2008 and will introduce VSTS integration and manual refactorings (we will merge CodeIt.Once into CodeIt.Right)
So, don't wait, go ahead, download CodeIt.Right - http://submain.com/download/codeit.right - play with it, explore the rules included in the box, get out of the box and try developing your own custom rules, share them, 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
|
|
|
|
|