TestingDocs.com
    Software Testing website
    • Automation
      • Selenium
      • JBehave Framework
    • Tutorials
      • MySQL Tutorials
      • Testlink
      • Maven
      • Git
    • IDEs
      • IntelliJ IDEA
      • Eclipse
    • Flowcharts
      • Flowgorithm
      • Raptor
    • About

    Raptor Flowchart

    Comments in Raptor Flowcharts

    Raptor Flowcharts

    Introduction

    Comments make RAPTOR flowcharts easy to understand by others. It’s a good programming practice to add meaningful comments to flowcharts. In this post, we will learn how to add comments to a RAPTOR flowchart. The interpreter and compiler ignore comments and are not executed during the run. Comments are meant for the human readers to understand the flowchart. Comments are used where the flowchart flow is complex and hard to understand by others.

    Comments in Raptor Flowcharts

     

    Raptor Comments in Flowchart

    Adding a comment

    To add a comment to a flowchart symbol in Novice & Intermediate mode to the flowchart, Right-click on the flowchart symbol and choose Comment.  The comment appears as a chat bubble next to the flowchart symbol. Comments can be a single-line or multi-line.

    Another way is to choose from the menu: Edit >> Comment

    Types of Comments

    Header comment

    A header comment is added at the beginning of the flowchart to describe the flowchart, and other metadata like Author, Date, Description of the flowchart, etc.

    Step Comment

    Step comment is added to a step in the flowchart to describe the purpose of the step, logic, etc. A flowchart can have multiple-step comments if desired.

    Header Comment

    We can add programmer header comments to the flowchart Start symbol. Header comments include

    • Author of the flowchart/program.
    • Date when the program was written.
    • General program description of what the flowchart does.

     

    Header Comment

     

     

    Enter the comment text in the “Enter comment” dialog box. Once you have added the comment, click on the Done button. We can double-click on the comment bubbles to edit or modify the comment text. We can also drag and move the comment bubble from flowchart symbol to symbol.

     

    Edit Comment Raptor

     

    The comment would show up beside the symbol as shown in the picture.

     

    Remove a comment

    To delete a comment, simply select it and right-click, then choose the delete option.
    Another way is to choose from the menu: Edit > Delete option.

     

    Delete Comment

     

    Comments add up to the documentation of the flowcharts and programs. They make the flowchart easy to understand for others. If you feel the flow is not self-explanatory, add appropriate comments to make them understandable to others.

    Comment in OO Mode

    Switch the RAPTOR tool to OO Mode.

    To add a comment to the UML diagram,

    Right-click >> New >> Comment

     

    Comment in OO Mode

     

    Double-click to edit the comment.

     

    Edit Comment Raptor

    Tips

    • Follow the flowchart Rubric guidelines set by the Teacher/Professor. Add Header comments to explain the flowchart description, name, date, etc.
    • Make Large flowcharts modular. Break the flowchart into smaller sub-charts or procedures. Add the purpose of each procedure as a comment in the procedure block.
    • Change History: Add a change history log to show how the flowchart evolved incrementally, fixing errors, etc.

    —

    Raptor Tutorials

    RAPTOR tutorials on this website:

    https://www.testingdocs.com/raptor-a-flowchart-tool/

    More information about RAPTOR:

    https://raptor.martincarlisle.com/

     

    Related Posts

    Install RAPTOR Avalonia CentOS

    Raptor Flowchart /

    Install RAPTOR Avalonia on CentOS

    RAPTOR Avalonia Edition Windows

    Raptor Flowchart /

    Download RAPTOR Avalonia Edition on Windows

    RAPTOR Editions

    Raptor Flowchart /

    RAPTOR Editions

    RAPTOR flowcart to write to a file output

    Raptor Flowchart /

    Write to a file with RAPTOR flowchart

    Sum of Squares Array Elements Modular Approach

    Raptor Flowchart /

    Sum of Squares of Given Array Elements

    ‹ IPO Chart› Procedure in Raptor flowcharts

    Recent Posts

    • Running Tests in Parallel with Selenium Grid
    • Advanced Selenium Features
    • Locating Web Elements
    • Running the Test Script
    • Writing Your First Selenium Test Script
    • Getting Started with Selenium Automation Testing
    • Setting Up the Environment
    • How can you monitor the Quality Assurance Audit?
    • Leveraging LambdaTest with Appium 2.0
    • Appium 2.0 Plugins ListAppium 2.0 Plugins
    • Touch Actions and Multi-Touch Actions
    • Changes in Drivers and Classes
    • Appium Inspector
    • Capabilities in Appium 2.0
    • Appium 2.0 Driver ListAppium 2.0 Driver Installation & Management
    CyberLink Multimedia Software

    Back to Top

    Links

    • Contact
    • Privacy Policy
    • Cookie Policy

    www.TestingDocs.com