Scribd Logo
Upload

Welcome to Scribd!

  • 65 views

    Code Review Java

    Uploaded by

    anarki85
    This document is a code review checklist for an IIB project. It contains 38 checklist items to review naming conventions, code structure, error handling, ESQL components, queues, scripts, and testing. The reviewer has left comments on some items noting naming conventions were close but not perfectly followed, a lack of event monitoring, unnecessary copy procedures, a need for more comments, and a request to document any special settings or use of HTTPS. Overall the project was given a pass but areas for future improvement were identified.

    Copyright:

    © All Rights Reserved
    Download as DOCX, PDF, TXT or read online from Scribd

    Code Review Java

    Uploaded by

    anarki85
    65 views3 pages
    This document is a code review checklist for an IIB project. It contains 38 checklist items to review naming conventions, code structure, error handling, ESQL components, queues, scripts, and testing. The reviewer has left comments on some items noting naming conventions were close but not perfectly followed, a lack of event monitoring, unnecessary copy procedures, a need for more comments, and a request to document any special settings or use of HTTPS. Overall the project was given a pass but areas for future improvement were identified.

    Original Description:

    Code

    Original Title

    Code Review java

    Copyright

    © © All Rights Reserved

    Available Formats

    DOCX, PDF, TXT or read online from Scribd

    Did you find this document useful?

    Is this content inappropriate?

    This document is a code review checklist for an IIB project. It contains 38 checklist items to review naming conventions, code structure, error handling, ESQL components, queues, scripts, and testing. The reviewer has left comments on some items noting naming conventions were close but not perfectly followed, a lack of event monitoring, unnecessary copy procedures, a need for more comments, and a request to document any special settings or use of HTTPS. Overall the project was given a pass but areas for future improvement were identified.

    Copyright:

    © All Rights Reserved
    Download as DOCX, PDF, TXT or read online from Scribd
    Download as docx, pdf, or txt
    65 views3 pages

    Code Review Java

    Uploaded by

    anarki85
    This document is a code review checklist for an IIB project. It contains 38 checklist items to review naming conventions, code structure, error handling, ESQL components, queues, scripts, and testing. The reviewer has left comments on some items noting naming conventions were close but not perfectly followed, a lack of event monitoring, unnecessary copy procedures, a need for more comments, and a request to document any special settings or use of HTTPS. Overall the project was given a pass but areas for future improvement were identified.

    Copyright:

    © All Rights Reserved
    Download as DOCX, PDF, TXT or read online from Scribd
    Download as docx, pdf, or txt
    You are on page 1of 3

    IIB CODE REVIEW CHECK LIST

    September 13, 2017

    PROJECT NAME:

    Prepared By: Reviewed By:

    Component Name New Project ☐

    Version Number Enhancement ☐

    # Code Check List YES NO N/A

    1 Project checked into RTC

    2 Project following RTC folder structure for IIB

    3 Naming conventions followed for Integration Projects

    4 _SERVER project created for bar files

    Flows

    5 Schemas used to create separation of flows

    6 Descriptive message flow names in lower camel case with no special


    characters

    7 Nodes descriptively named with same case applied throughout

    8 Logical groupings of work / re-usable components developed as subflows

    9 Sub flow names in lower camel case with meaningful names

    10 Generic Error Handling subflows used or new common component subflow


    written for error handling

    11 Input / output nodes showing queue name as label or function ( ie


    distributionList)

    12 Nodes in flow named to indicate the function / role that it is playing

    13 Event monitoring enabled on key nodes

    ESQL components

    14 Naming standards adhered too ( no *_compute, text case the same for all
    components, descriptive verbs used,
    # Code Check List YES NO N/A

    15 Reserved words in uppercase

    16 Module copyEntireMessage() removed unless used

    17 Comment provided where needed in consistent format

    18 Wrapping, indenting and alignment consistent through out

    19 Every statement placed on separate line

    20 Referenced declared and used to avoid excessive navigation of message trees

    21 Reference variables (REFERENCE TO) declared with ref keyword (i.e.


    refHeader REFERENCE TO)

    22 Variable names declared in lower camel case with no excessive use

    23 Single statement used for variable declarations instead of multiples

    24 Variable declarations at beginning of function, procedure or module

    25 Are whitespace used in the following places to improved readability


    - Two blank lines between sections of eSql file
    - One blank line between functions and procedures
    - One blank line between variable declarations in a function / procedure
    and the first statement line
    - One blank line before a block or single-line comment
    - A blank space should follow each comma in any eSql statement that
    makes use of commas apart from within a literal string
    - All binary operators ( = <>) should be separated from their operands
    by spaces

    26 Preferable WHILE Loop with references used.

    27 No endless loops in code

    28 Properties.ReplyIdentifier set when using message or correlation id in reply

    Queues

    29 Queue names as per design document and naming standard (uppercase)

    30 Queue scripts created and checked into SERVER project

    31 Alias queue names used for remote queues and queues with environment
    names included

    Scripts

    32 Scripts for configurable services & other components that needs command line
    actions checked in and adequately named

    Test Results

    33 Unit test results available

    2
    # Code Check List YES NO N/A

    34 SOAP UI project available and checked in

    Designed for Performance

    35 No unnecessary nodes or call in flow

    36 Traversing of message structure kept to a minimum

    37 Validation on SOAP Input nodes off when exposed to Datapower

    38 DFDL used instead of MRM

    COMMENTS:
    3 Naming convention not strictly observed but close enough for a pass

    6 Mixture of cases not camel case in all instances for example internationalremittancesInput.msgflow

    10 Assuming that error handling is specific to each operations as there is database updates in code

    13 No event monitoring enabled

    14 CopyMessageHeaders and CopyEntireMessage kept in procedures. Please try and rename in


    future to something more specific to code.

    16 Please get rid of all unnecessary CopyMessageHeaders as part of code

    17 Could provide more comments but given timelines acceptable

    32 can see queue scripts but do need a file with configurable endpoints per environment

    Note: Please add comment notes on flows where special settings was enabled and where https should be used

    You might also like