Skip to content

Code Review Workflow

Learn how to use Jake effectively for reviewing and improving your LabVIEW code. This guide walks you through a systematic approach to code review using Jake's analysis capabilities.

Initial Code Assessment

Begin your code review by getting a comprehensive quality assessment. Use Jake's review command (see Features) to analyze your code:

! @bd Review this VI's implementation

Jake will provide detailed metrics about code quality, including scores for complexity, error handling, organization, and documentation. Use this initial assessment to identify areas needing attention.

Architecture Evaluation

Next, evaluate the architectural approach using the pattern command:

$ @bd Analyze the design pattern implementation

This helps you understand if your code follows LabVIEW best practices and implements patterns correctly. Pay particular attention to: - Error handling approaches - Data flow architecture - State management - Resource usage

Documentation Review

Check your VI's documentation using the comment command:

+ @bd Review the documentation completeness

Jake will assess your existing documentation and suggest improvements for: - VI descriptions - Control and indicator documentation - Interface specifications - Usage examples

Iterative Improvement

Address issues in order of priority:

  1. First, fix any critical issues Jake identified in the review
  2. Then implement architectural improvements suggested by the pattern analysis
  3. Finally, enhance documentation based on Jake's suggestions

After each significant change, run another review:

! @bd Check if my changes improved the implementation

Final Verification

Before completing your review:

  1. Verify error handling: 

    ? @bd Explain the error handling implementation

  2. Check performance considerations: 

    ! @bd Focus on performance metrics

  3. Confirm documentation completeness: 

    + @bd Is the documentation now complete?

Remember, effective code review is iterative. Use Jake's feedback to guide improvements, and don't hesitate to ask for clarification about specific recommendations.