SubMain - CodeIt.Right The First Time!

/Community

Support Community for SubMain Products
 Home Products Services Download Purchase Support
in Search
 
Home Forums Blogs Tutorials/CIR Tutorials/GD Downloads
Welcome to SubMain Community Sign in | Join | Help

SubMain Blog

Browse by Tags

All Tags » News » Releases   (RSS)

  • Released: GhostDoc v5.5

    GhostDoc version 5.5 delivers compatibility with VS2017 RTM as well as a number of fixes:

    • VS2017 RTM support
    • GhostDoc is now also available as VSIX for VS2017
    • Documentation Hints no longer visible in the Debug mode
    • Fixed issue wrapping lines within the <value></value> tag
    • In the Offline Activation Preview - the fields are now auto-selected on focus/click for easy copying
    • GhostDoc is no longer adding extra line when re-documenting header in VB
    • GhostDoc is no longer appending generated XML comments to the existing comment when using auto-generated properties in VB

    For the complete list of changes, please see What's New in GhostDoc v5

    For overview of the v5.0 features, visit Overview of GhostDoc v5.0 Features

    Download the new build at http://submain.com/download/ghostdoc/

  • Released: CodeIt.Right v3.0

    The v3.0 of CodeIt.Right v3 is here – the new major version of our automated code review and code quality analysis product. Here are the v3.0 new feature highlights:

    • VS2017 RC integration
    • Official support for VS2015 Update 3 and ASP.NET 5/ASP.NET Core 1.0 solutions
    • Solution filtering by date, source control status and file patterns
    • Summary report view - provides a summary view of the analysis results and metrics, customize to your needs
    • New Review Code commands – review opened files and review checked out files
    • Improved Profile Editor with advanced rule search and filtering
    • Improved look and feel for Violations Report and Editor violation markers
    • Setting to keep the OnDemand and Instant Review profiles in sync
    • New Jenkins integration plugin
    • Batch correction is now turned off by default
    • Most every CodeIt.Right action now can be assigned a keyboard shortcut
    • New rules

    For the complete and detailed list of the v3.0 changes see What's New in CodeIt.Right v3.0


    Solution Filtering

    The solution filtering feature allows to narrow the code review scope to using the following options:

    • Analyze files modified Today/This Week/Last 2 Weeks/This Month – so you can set the relative date once and not have to change the date every day
    • Analyze files modified since specific date
    • Analyze files opened in Visual Studio tabs
    • Analyze files checked out from the source control
    • Analyze only specific files – only include the files that match a list of file patters like *Core*.cs or Modules\*. See this KB post for the file path patterns details and examples.

    cir-v3-solution-filtering

    New Review Code commands

    We have changed the Start Analysis menu to Review Code – still the same feature and the new name is just highlighting the automated code review nature of the product. Also added the following Review Code commands:

    • Analyze Open Files menu - analyze only the files opened in Visual Studio tabs
    • Analyze Checked Out Files menu - analyze only files that that are checked out from the source control

    cir-v3-profile-filterImproved Profile Editor

    The Profile Editor now features

    • Advanced rule filtering by rule id, title, name, severity, scope, target, and programming language
    • Allows to quickly show only active, only inactive or all rules in the profile
    • Shows totals for the profile rules - total, active, and filtered
    • Improved adding rules with multiple categories

     

    Summary Report

    The Summary Report tab provides an overview of the analyzed source code quality, it includes the high level summary of the current analysis information, filters, violation summary, top N violation, solution info and metrics. Additionally it provides detailed list of violations and excludes.

    The report is self-contained – no external dependencies, everything it requires is included within the html file. This makes it very easy to email the report to someone or publish it on the team portal – see example.

    cir-v3-summary-report-part

    The Summary Report is based on an ASP.NET Razor markup within the Summary.cshtml template. This makes it very easy for you to customize it to your needs.

    You will find the summary report API documentation in the help file – CodeIt.Right –> Help & Support –> Help –> Summary Report API.

    cir-v3-summary-source

     

    How do I try it?

    Download the v5.0 at http://submain.com/download/codeit.right/

    Feedback is what keeps us going!

    Let us know what you think of the new version here - http://submain.com/support/feedback/


    Note to the CodeIt.Right v2 users
    : The v2.x license codes won't work with the v3.0. For users with active Software Assurance subscription we have sent out the v3.x license codes. If you have not received or misplaced your new license, you can retrieve it on the My Account page. Users with expired Software Assurance subscription will need to purchase the new version - currently we are not offering upgrade path other than the Software Assurance subscription. For information about the upgrade protection see our Software Assurance and Support - Renewal / Reinstatement Terms

  • Released: GhostDoc v5.4 update

    Version 5.4 of GhostDoc is a maintenance update for the v5.0 users:

    • VS2017 RC integration
    • New menu items - Getting Started Tutorial and Tutorials and Resources
    • (Pro) (Ent) Edit buttons in Options - Solution Ignore List and Options - Spelling Ignore List
    • (Pro) (Ent) Test button in Options - Solution Ignore List
    • (Ent) Now GhostDoc shows error message when Conceptual Content path is invalid in the solution configuration file
    • Fixed PathTooLongException exception when generating preview/build help file for C++ projects
    • (Ent) Updated ClassLibrary1.zip, moved all conceptual content files inside the project in GhostDoc Enterprise\Samples\Conceptual Content\
    • Improved documenting ReadOnly auto-properties in VB
    • Resolved issue re-documenting a type at the top of source code file in VB
    • Resolved issue with generating preview of the <seealso> tag for generics in VB

    For the complete list of changes, please see What's New in GhostDoc v5

    For overview of the v5.0 features, visit Overview of GhostDoc v5.0 Features

    Download the new build at http://submain.com/download/ghostdoc/

  • Released: GhostDoc v5.3 update

    Version 5.3 of GhostDoc is a maintenance update for the v5.0 users:

    • Added full support for string interpolation in C# and VB parsers
    • Added support for "arrow functions" in JavaScript parser
    • Fixed "File is not part of a solution" issue when loading projects
    • (Pro) (Ent) Added IsAbstract property to CurrentCodeElement in the T4 templates
    • Improved exception documentation - now the type name in a nameof() parameter is added as part of the generated documentation template
    • (Ent) Fixed iue when using <section> along with <code> elements in an .aml file

    For the complete list of changes, please see What's New in GhostDoc v5

    For overview of the v5.0 features, visit Overview of GhostDoc v5.0 Features

    Download the new build at http://submain.com/download/ghostdoc/

  • Released: GhostDoc v5.2 update

    Version 5.2 of GhostDoc is a minor feature release for the v5.0 users includes:

    • Support for Visual Studio 2015 Update 3
    • Fixes for the latest ASP.NET Core projects
    • GhostDoc now treats underscore as a delimiter to improve summary generation for underscore delimited identifiers
    • "Use Modern URLs" Help Configuration option for declarative help documentation file naming - namespace-classname-membername.htm
    • Option to turn on/off Documentation Hints during setup
    • (Pro) (Ent)Comment Preview is now rendered using the FlatGray theme
    • Plenty of improvements and bug fixes

    For the complete list of changes, please see What's New in GhostDoc v5

    For overview of the v5.0 features, visit Overview of GhostDoc v5.0 Features

    This version is a required update for Visual Studio 2015 Update 3 users.

    Download the new build at http://submain.com/download/ghostdoc/

  • Released: GhostDoc v5.1 update

    Version 5.1 of GhostDoc is a maintenance release for the v5.0 users; includes minor enhancements and number of important bug fixes. Many of the fixes are relevant to the Visual Studio 2015 environment, so while everyone will benefit from this update, it is highly recommended for the Visual Studio 2015 users.

    For the complete list of changes, please see http://support.submain.com/kb/a42/whats-new-in-ghostdoc-v5.aspx

    For overview of the v5.0 features, visit http://submain.com/blog/ReleasedGhostDocV50.aspx

  • Released: GhostDoc v5.0

    Note to GhostDoc Pro v4 users: The v4 licenses won’t work with the v5. We will be sending new license codes shortly to users with License Protection and active Software Assurance subscription. See more information at the bottom of this post.

    Both Pro and Enterprise editions of GhostDoc in version 5 introduce Documentation Quality hints in Visual Studio editor; Documentation Management assistance - find auto-generated comments, edit or remove the bulk created docs; identify and fix comments that are missing, out of sync or can be copied from base class; mark generated XML comments as auto-generated and "to be edited". The v5 also includes multiple Help documentation themes and layouts to choose from.

    The free version of GhostDoc has been re-branded as GhostDoc Community Edition and adds general improvements, limited generation of CHM help documentation as well as the means to find auto-generated comments.

    GD_v5_new_commands

    The new menu commands

    • Documentation Quality Hints in Visual Studio editor
    • Documentation Maintenance - Find auto-generated comments - edit or remove the bulk created docs
    • Documentation Maintenance - Identify and fix comments that are missing, out of sync or can be copied from base class
    • Theme support for generated help documentation and new themes - Flat Gray and Flat Main
    • Official Visual Studio 2015 support
    • Options to add Auto-generated doc and TODO 'Edit' attributes
    • Option to have the default summary text focused and selected when using Document This command - allows to edit/override the summary quickly
    • Exclude from Documentation action – marks a member with a tag to exclude it from the help documentation
    • Hide/Show Comments feature – an easy way to expand/collapse documentation comments to minimize the XML Comments footprint in the Visual Studio code editor
    • New Summary Override table in Options - configure predefined summaries for specific member or type names instead of auto-generated
    • A basic Build Documentation feature is now available in the Community Edition of GhostDoc – while quite limited and watermarked, yet allows to produce simple CHM help documentation for personal use without paying for the commercial version

    For the detailed list of v5.0 changes see What’s New in GhostDoc v5.

    To see new features by product edition see this page - http://submain.com/ghostdoc/editions/


    Documentation Quality Hints

    This new feature provides real-time visual hints in the Visual Studio Editor window to highlight members which have documentation issues that require attention.

    GD_v5_maint_hints

    The following documentation hint actions included with this release make it very easy to maintain the documentation quality:

    GD_v5_maint_hints_list


    Documentation Maintenance

    This feature will help you identify missing documentation, find auto-generated XML comments, maintain your documentation, and keep it up to date. Once these are found, GhostDoc provides the tools to edit or remove the bulk created docs, add missing or fix the dated documentation – one by one or as a batch. You can fine tune the search criteria and use your own template library if yours is different from the built-in.

    • Find auto-generated docs and edit or remove them
    • Find and fix members that are missing documentation
    • Discover members that have parameters, return types, and type parameters out of sync with the existing XML comments and fix the comments
    • Find members that can have XML docs copied from the base class
    • Find documentation that require editing

    GD_v5_maint_autogen

    The Community Edition only allows to find auto-generated documentation and not batch actions – only one action at a time.


    Help Documentation Themes

    In the v5 we are introducing theme support for the generated help documentation and including two new themes, The old help doc view preserved as the Classic theme. You can see the new theme preview here - Flat Gray (default) and Flat Main.

    The Enterprise Edition users can modify the existing themes or create and deploy own help documentation themes – now easier than ever!

    The Community Edition theme selection is limited to one – Classic.

    GD_v5_help_sample


    Auto-generated doc and TODO 'Edit' attributes

    The option to add <autogeneratedoc /> tag to XML comment is intended to provide an explicit flag that the comment has been generated automatically.

    The option to add a TODO comment “TODO Edit XML Comment Template for {member name}” which in turn adds a TODO task into the Visual Studio Task List –> Comments as a reminder for the auto-generated comment requires editing.

    GD_v5_autogen_todo

    Both flags can be used as additional criteria for the documentation quality hints and documentation management “Find auto-generated Documentation” feature. When generating help documentation these flags are also accounted for – the flagged members can be included, ignored or highlighted in the final docs.


    Summary Override

    The Summary Override table allows to configure predefined summaries for specific member or type names to be used instead of the auto-generated. We ship some predefined summary overrides and you are welcome to add your own. If you find a summary override that the GhostDoc user community can benefit of, please submit it to us to be reviewed for the inclusion.

    GD_v5_summary_override

     

    How do I try it?

    Download the v5.0 at http://submain.com/download/ghostdoc/


    Feedback is what keeps us going!

    Let us know what you think of the new version here - http://submain.com/support/feedback/


    Note to the GhostDoc Pro v4 users
    : The v4.x license codes won't work with the v5.0. For users with License Protection and active Software Assurance subscription we will be sending the v5.x license codes shortly. If you need your v5 license sooner, please let us know and we will send one to you. Users without the License Protection or with expired Software Assurance subscription will need to purchase the new version - currently we are not offering upgrade path other than the Software Assurance subscription. For information about the upgrade protection see our Software Assurance and Support - Renewal / Reinstatement Terms

  • Released: CodeIt.Right v2.7

    CodeIt.Right v2.7 is a maintenance release that includes:

    • Support for VS2013 Update 3 and newer
    • Improved compatibility with Shared/Universal App projects
    • Exported Violation Report now includes profile name, severity threshold, version of CodeIt.Right and duration of the analysis
    • Exported Violation Report now includes information about Excluded Projects, Files, Rules and Violations
    • Command line version console output shows profile name as well as number of excluded projects, files, rules and violations
    • Other improvements and fixes

    For detailed list please see What's New in CodeIt.Right v2.7

    How do I try it?

    Download v2.7 at http://submain.com/download/codeit.right/

  • Released: GhostDoc v4.9 Update 1

    GhostDoc v4.9 Update 1 adds support for Shared Projects in all editions and introduces command line version in the Enterprise Edition:

    • (Ent) New feature - command line version - enables generating help documentation during build process for a specific Help Configuration
    • Added support for Visual Studio 2013 Update 2 Shared Projects/Universal Apps
    • Improvements and bug fixes

    For detailed list of changes and fixes please see What's New in GhostDoc v4.x

    How do I try it?

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

  • Released: CodeIt.Right v2.6

    CodeIt.Right v2.6 adds support for Shared Projects, introduces automated refractorings for the majority of StyleCop rules (when using StyleCop integration), performance improvements and fixes:

    • Support for Shared Project introduced in VS2013 Update 2
    • In v2.5 we added StyleCop integration into CodeIt.Right analysis. In v2.6 we are adding 93 auto-fix refactorings for StyleCop violations and currently covering automatic correction for 85% of StyleCop based violations (143 out of 164)
    • Improved performance of the built-in profiles by turning off few processing intensive optional rules. You can turn them back on by creating custom profiles
    • Tweaked a number of rules and instances for better conformance to Microsoft Design Guidelines
    • SuppressMessage improvements for local variables
    • Improvements and bug fixes

    For detailed list please see What's New in CodeIt.Right v2.6

    How do I try it?

    Download v2.6 at http://submain.com/download/codeit.right/

  • Released: GhostDoc v4.9

    GhostDoc v4.9 is primarily a stability release but it also introduces new Enterprise edition feature:

    • (Ent) New feature - ability to add custom pages to produced help documentation in GhostDoc Enterprise via Conceptual Content concept
    • Improvements and bug fixes

    For detailed list of changes and fixes please see What's New in GhostDoc v4.x

    How do I try it?

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

  • Released: CodeIt.Right v2.5

    As an active member of the Microsoft Visual Studio Industry Partner (VSIP) program, we again are proud to be VS2013 sim-ship partner and shipping all editions of CodeIt.Right v2.5 today simultaneously with the release of Visual Studio 2013.

    This release includes official and complete support for Visual Studio 2013, new plugin to integrate StyleCop into CodeIt.Right analysis, updated look for Violations Report Export, performance improvements and fixes: codeit.right_v2.5_new_339x213

    • Official Visual Studio 2013 support
    • New plugin integrates StyleCop into CodeIt.Right analysis
      • Run StyleCop rules as part of CodeIt.Right Analysis
      • CodeIt.Right auto-corrections for StyleCop rules
      • Exclude StyleCop rules or violations
      • On Demand Analysis - include StyleCop violations into CodeIt.Right Violations Report
      • Instant Code Review - include StyleCop violations as part of CodeIt.Right Violations Report
      • Instant Code Review - show StyleCop violations in VS Editor and violations bar
      • Command Line - include StyleCop violations into the analysis
    • Revamped XSLT stylesheet for Violations Report Export to XML
    • Auto-corrections in Instant Code Review mode now show "growl" type warnings
    • CRDATA file format change - your existing CRDATA files will convert automatically
    • Async loading of saved violation reports for improved performance

    For detailed list please see What's New in CodeIt.Right v2.5

    How do I try it?

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

  • Released: GhostDoc v4.8

    As an active member of the Microsoft Visual Studio Industry Partner (VSIP) program, we again are proud to be VS2013 sim-ship partner and shipping all editions of GhostDoc v4.8 today simultaneously with the release of Visual Studio 2013.

    This release includes official and complete support for Visual Studio 2013 as well as number of improvements and fixes. For details please see What's New in GhostDoc v4.8

    How do I try it?

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

  • Released: GhostDoc v4.7

    We are happy to introduce the release of GhostDoc v4.7, a version that is greatly influenced by feedback from our users. It extends Visual Studio 2013 support and introduces an Enterprise version, Help Configurations, Help Content Targeting, embedding images into help markup, hyperlinking to base .NET Framework classes, abbreviation expansion, Non-breaking Words list, and much more:

    • Visual Studio 2013 support
    • Introduced GhostDoc Enterprise
    • (Pro) New Help Configuration feature - save custom configured help generation settings and switch between them easily
    • (Pro) Help Content Targeting - ability to create a (partial) 'filtered' help file based on attributes by using <tags/> in XML Comment and tag filtering in Help Configuration. If you need to have different help content for public API users, testers, internal documentation, etc, you can do that now!
    • New Abbreviations dictionary enables expanding abbreviations to full words (for example, 'args' -> 'arguments')
    • New Non-breaking Words list to preserve splitting when comment template is generated (for example, 'CheckBox' or 'ListView')
    • (Pro) Embed/reference images into the Help markup
    • (Pro) Option to skip documenting private/internal/protected members with Document File/Type batch commands
    • (Pro) .NET Framework classes are now hyperlinked to corresponding Microsoft reference page for additional information
    • (Ent) Customize Comment Preview
    • (Ent) Customize help layout and template

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

    GhostDoc Enterprise

    We have identified a clear need for a new kind of GhostDoc product, specifically suitable for enterprises and customers who need advanced configuration features for the help file output.

    The GhostDoc Enterprise version that we are officially introducing today offers silent deployment options, full customization of the template and layout of the Comment Preview and Help Files. The Enterprise license customers are also eligible for the on-premises Enterprise Licensing Server option.

    For edition comparison please see this page - http://submain.com/ghostdoc/editions/

    HelpConfiguration

    Help Configuration and Help Content Targeting

    The new Help Configuration feature enables you to create ready-to-use help generation profiles. You can easily switch between profiles, depending on what kind of help you are producing. Also you can define attributes with <tags /> in XML Comment and use tag filtering in Help Configuration to target Help content to your specific audience.

    Help Configuration profiles include settings for:

    • Output format
    • Scope
    • Projects to include
    • Header and footer
    • New tag filtering for help content targeting

    How do I try it?

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

    Feedback is what empowers us!

    Let us know what you think of the new version here - http://submain.com/support/feedback/

  • Released: CodeIt.Right v2.2

    CIR_Violations_ErrorList

    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/

More Posts Next page »
    

This Blog

Syndication

 
     
 
Home |  Products |  Services |  Download |  Purchase |  Support |  Community |  About Us |