PreviousUpNext

12.11  Bridge comments

Use bridge comments to visually connect the dots.

For example, often the proximity of the first two lines of a close-packed case statement confuses the eye

    case (mimble mamble mumble)
        TIMBLE => tamble tumble;
        FIMBLE => famble fumble;
    esac;

but adding a blank line makes the case statement visually fall to pieces:

    case (mimble mamble mumble)

        TIMBLE => tamble tumble;
        FIMBLE => famble fumble;
    esac;

A bridge comment gives the code room to breathe while still tying it together into a visual whole:

    case (mimble mamble mumble)
        #
        TIMBLE => tamble tumble;
        FIMBLE => famble fumble;
    esac;

Comments and suggestions to: bugs@mythryl.org

PreviousUpNext