Automated Code Decoration for Review Efficiency

Resolve Bottlenecks,
Find Innovative SolutionsGenerate Solutions

Solution Overview

Problem

Complex computer programs require collaborative authoring and review, but existing tools lack automated features to enhance the visual understanding and efficiency of code review, making it difficult to manage and improve the quality of code changes.

Innovation Solution

An automated system that evaluates code context and adds visually associated decorations, such as review tips, comments, and revision markings, to facilitate the review process by providing additional information like tested vs. untested code and complexity indicators.

Engineering Contradictions & Design Principles

VSEngineering Contradiction Analysis

1Productivity

If code review is performed manually without automated decorations, then reviewers can understand the review process, but the review efficiency is low and it is difficult to manage complex code changes

Engineering Contradiction:

Improvecode review efficiencyVSAvoidcomplexity of managing code changes

Core Design Contradiction:

ProductivityVSDevice complexity

Solution Approach 1:

The system performs preliminary analysis of code changes before the review process, automatically generating decorations such as complexity indicators, test coverage markers, and potential bug highlights. This preliminary action prepares the code review interface with pre-computed information, reducing the manual effort required during actual review and improving efficiency without adding complexity to the review management process

Inventive Principle:

Principle #10Preliminary action

Solution Approach 2:

The patent introduces an intermediary layer (automated decorations) between the raw code changes and the reviewer. This intermediary process transforms complex code diff data into visually annotated representations that highlight important aspects, making it easier for reviewers to understand and manage complex changes without being overwhelmed by the raw complexity

Inventive Principle:

Principle #24Intermediary (Mediator)

2Ease of operation

If automated decorations are added to code, then visual understanding and review efficiency are improved, but the system complexity increases

Engineering Contradiction:

Improvevisual understanding of codeVSAvoidcomplexity of automated decoration system

Core Design Contradiction:

Ease of operationVSDevice complexity

Solution Approach 1:

The automated decoration system is segmented into independent analysis modules, each responsible for generating specific types of decorations (e.g., complexity analysis, test coverage, bug detection). This segmentation allows the system to manage complexity by dividing it into manageable, specialized components that can be independently developed and maintained while collectively providing comprehensive visual enhancements

Inventive Principle:

Principle #1Segmentation

Solution Approach 2:

The system applies different decoration types locally to specific portions of code based on their characteristics. Rather than applying a uniform decoration approach throughout, the system analyzes local code context and applies appropriate decorations only where needed, improving visual understanding without requiring a complex system that processes every line uniformly

Inventive Principle:

Principle #3Local quality

Data Source

PatentUS8635598B2Automatic code decoration for code review

Publication Date: 2014.01.21 MICROSOFT TECHNOLOGY LICENSING LLC

AI summary

The automated generation of code decoration for a body of code under review. Upon accessing the body of code, the system evaluates portions of the code for context. For at least some of those portions of code, the system identifies a decoration corresponding to that context, and adds the identified decoration to the body of code in a manner that the decoration is visually associated with the corresponding portion of the code.