Getting Started with EventStudio Introduction to FDL Comments, Remarks and Issues Object Management and Message Parameters Timer and Resource Management State Machine Operations, Actions and Environment Defining Types for Modules, Processors and Objects Multiple Scenario Support Tutorial Sequence Diagram pdf

Home > EventStudio System Designer > Sequence Diagram Tutorial > Comments and Remarks
Sequence Diagram Comments, Remarks and Issues

• C-Type comments
• Remarks
• Block Remarks
• Issue statement

Standard C-type comments are supported for programmer documentation. Remarks and Block Remark comments allow the user to explain the feature flow. There output will appear in the PDF documents. Issue statements are used to keep track of unfinished sections and review comments. Issue statements output appears in the PDF output as well as Output Window at the bottom of the screen.

     module : customer, exchange
     processor : phone in customer
     processor : frontend in exchange, core in exchange
1.   /* Originating Call Setup */
feature "Call Setup"
        offhook : phone -> frontend
2.      (* Subscriber lifts the phone to initiate a call *)
dialtone : frontend -> phone
        digits : phone -> frontend
        setup_call : frontend -> core
3.      issue "Call setup parameters have not been defined"
setup_complete : core -> frontend
4.      [* Setup complete, waiting for called susbcriber to be rung *]
ringback : core -> phone
    endfeature

1. FDL supports C-type comments enclosed in /* comment */. Multi-line comments can be placed between any FDL statements. EventStudio will ignore these comments during the initial review. C-type comments have no impact of the FDL output documents.
2. FDL supports remarks enclosed in (* remark *). The remarks are always printed on the right side remark column of PDF documents. FDL associates remarks with the previous FDL statement. In this case, the remark corresponds to the message statement sending an offhook from the phone to the frontend. Remarks should generally be defined for almost every statement. This helps the reader in quickly understanding the feature.
3. An issue statement can be added whenever the author has some unresolved issues. These statements are printed in bold on in the remarks column. Issue statements are reported in the output window whenever the author reviews the document. This allows the author to quickly identify if any issues are unresolved. This statement may also be used to provide review comments on an FDL file.
4. FDL supports block remarks enclosed in [* block remark *]. Block remarks are always printed along the complete width of the PDF output page. The block remarks do not associate with any FDL statement. Use block remarks to show milestones in the execution of a feature. They may also be used to define large remarks that would not fit as a normal remark.

Notes:

• Block remarks [* block remark *] and remarks (* remark *) can be multi-line.
• Block remarks also support division of text into multiple paragraphs.