jgrasp handbook

More documents

Recommendations

Info

DRAFT, February 18, 2003, Page 32 Figure 29 shows the binarySearch method after the CSD has been generated. Although all necessary control information is in the source text, the CSD provides additional visual stimuli by highlighting the sequence, selection, and iteration in the code. The CSD notation begins with symbol for the method itself Þßà followed by the individual statements coming off the stem as it extends downward. The declaration of primitive data is highlighted with special symbol í appended to the statement stem. The CSD constructs for the while statement is represented by the double line “loop” (with break at the top), and the if statement uses the familiar diamond icon from traditional flowcharts. Finally, the two ways to exit from this method are shown explicitly with an arrow drawn from inside the method through the method stem to the outside. Figure 29. binarySearch with CSD While this is a small piece of code, it does illustrate the basic CSD constructs. However, the true utility of the CSD can be realized best when reading or writing larger, more complex programs, especially when control constructs become deeply nested. A number of studies involving the CSD have been done and others are in progress. In one of these, CSD was shown to be preferred significantly over four other notations: flowchart, Nasi-Schneiderman chart, Warnier-Orr diagram, and the action diagram [Cross 19xx]. In a several later studies, empirical experiments were done in which source code with the CSD was compared to source code without the CSD. In each of these studies, the CSD was shown provide significant advantages in numerous code reading activities [Hendrix 20xx]. In the few sections, the CSD notation is described in more detail. 3.2 CSD Program Components/Units The CSD includes graphical constructs for the following components or program units: class, abstract class, method, and abstract method. The construct for each component includes a unit symbol, a box
DRAFT, February 18, 2003, Page 33 notation, and a combination of the symbol and box notation. The symbol notation provides a visual cue as to the specific type of program component. It has the most compact vertical spacing in that it retains the line spacing of source code without the CSD. The box notation provides a useful amount of vertical separation similar to skipping lines between components. The symbol and box notation is simply a combination of the first two. Most of the examples in this <strong>handbook</strong> use the symbol notation because of its compactness. CSD notation for program components/Units is illustrated in the table below. Component class or Ada package abstract class method or function or procedure abstract method ÏÕÖ× ÏÏ§{ ÏÏ©} ÏØÓì ÏÏ§{ ÏÏ©} Symbol Notation ÏÞßà ÏÏ§{ ÏÏ¨¹¹Ï; ÏÏ©} Ï ÛÜÝ Box Notation Ï¡¥¥¥¥¥¥¥¥¥ Ï¢ Ï£¤¦¦¦¦¦¦¦¦ ÏÏ§{ ÏÏ©} Ï¡¥¥¥¥¥¥¥¥¥ Ï¢Ï Ï£¤¦¦¦¦¦¦¦¦ ÏÏ§{ ÏÏ©} Ï¬¹¹¹¹¹¹¹¹¹ Ï§ ÏªË¹¹¹¹¹¹¹¹ ÏÏ§{ ÏÏ¨¹¹Ï; ÏÏ©} Ï¬¹¹¹¹¹¹¹¹¹ Ï§ Ïª¹¹¹¹¹¹¹¹¹ Symbol and Box Notation Ï¡¥¥¥¥¥¥¥¥¥ ÕÖ× Ï£¤¦¦¦¦¦¦¦¦ ÏÏ§{ ÏÏ©} Ï¡¥¥¥¥¥¥¥¥¥ ØÓì Ï£¤¦¦¦¦¦¦¦¦ ÏÏ§{ ÏÏ©} Ï¬¹¹¹¹¹¹¹¹¹ Þßà ÏªË¹¹¹¹¹¹¹¹ ÏÏ§{ ÏÏ¨¹¹Ï; ÏÏ©} Ï¬¹¹¹¹¹¹¹¹¹ ÛÜÝ Ïª¹¹¹¹¹¹¹¹¹
Page 1 and 2: The Table of Contents Index Handboo
Page 3 and 4: DRAFT, February 18, 2003, Page ii 4
Page 5 and 6: DRAFT, February 18, 2003, Page iv 1
Page 7 and 8: DRAFT, February 18, 2003, Page vi 2
Page 9 and 10: Overview of jGRASP DRAFT, February
Page 11 and 12: DRAFT, February 18, 2003, Page 3 sp
Page 13 and 14: DRAFT, February 18, 2003, Page 5 Pr
Page 15 and 16: DRAFT, February 18, 2003, Page 7 Co
Page 17 and 18: 11 Control Structure Diagram (CSD)
Page 19 and 20: 1 Installing jGRASP DRAFT, February
Page 21 and 22: 2.1 Creating a New File DRAFT, Febr
Page 23 and 24: In the upper right corner of the CS
Page 25 and 26: 2.2 Saving a File DRAFT, February 1
Page 27 and 28: 2.4 Loading a File DRAFT, February
Page 29 and 30: DRAFT, February 18, 2003, Page 21 4
Page 31 and 32: DRAFT, February 18, 2003, Page 23 O
Page 33 and 34: 2.7 Line Numbers DRAFT, February 18
Page 35 and 36: DRAFT, February 18, 2003, Page 27 T
Page 37 and 38: 2.9 Running a Program DRAFT, Februa
Page 39: 3 The Control Structure Diagram (CS
Page 43 and 44: Selection (cont’d) switch (when b
Page 45 and 46: 3.4 CSD Templates DRAFT, February 1
Page 47 and 48: 3.6 Reading Source Code with the CS
Page 49 and 50: Consider the fragment at right with
Page 51 and 52: 4 Projects DRAFT, February 18, 2003
Page 53 and 54: 4.2 Adding files to the Project DRA
Page 55 and 56: 4.4 Generating Documentation for th
Page 57 and 58: 4.5 Jar file Creation and Extractio
Page 59 and 60: DRAFT, February 18, 2003, Page 51 I
Page 61 and 62: DRAFT, February 18, 2003, Page 53 j
Page 63 and 64: DRAFT, February 18, 2003, Page 55 M
Page 65 and 66: DRAFT, February 18, 2003, Page 57 a
Page 67 and 68: 5.5 Displaying Dependencies Between
Page 69 and 70: 5.8 Saving the UML Layout DRAFT, Fe
Page 71 and 72: DRAFT, February 18, 2003, Page 63 b
Page 73 and 74: DRAFT, February 18, 2003, Page 65 t
Page 75 and 76: DRAFT, February 18, 2003, Page 67 V
Page 77 and 78: DRAFT, February 18, 2003, Page 69 T
Page 79 and 80: Part 2 - Reference DRAFT, February
Page 81 and 82: DRAFT, February 18, 2003, Page 73 i
Page 83 and 84: 9.4 Requirements for the Integrated
Page 85 and 86: 13 Known Bugs DRAFT, February 18, 2
Page 87 and 88: Unicode support - this will require
Page 89 and 90: Section 3. Disclaimer of Warranty D
Page 91 and 92:
* . * DRAFT, February 18, 2003, Pag
Page 93 and 94:
DRAFT, February 18, 2003, Page 85 A
Page 95 and 96:
DRAFT, February 18, 2003, Page 87 S
Page 97 and 98:
17.13 Projects DRAFT, February 18,
Page 99 and 100:
17.18 Jar/Zip Extractor Dialog DRAF
Page 101 and 102:
DRAFT, February 18, 2003, Page 93 e
Page 103 and 104:
18.8 Find Dialog / Page DRAFT, Febr
Page 105 and 106:
DRAFT, February 18, 2003, Page 97 s
Page 107 and 108:
\xnn hexadecimal representation of
Page 109 and 110:
DRAFT, February 18, 2003, Page 101
Page 111 and 112:
Page 113 and 114:
22.5 View Menu DRAFT, February 18,
Page 115 and 116:
• CSD Page • Colors Page • Fo
Page 117 and 118:
Page 119 and 120:
23.2.1.11 View Page DRAFT, February
Page 121 and 122:
Page 123 and 124:
23.4.3 UML Print Settings Page Marg
Page 125 and 126:
File syncing may cause jGRASP to lo
Page 127 and 128:
Page 129 and 130:
flags..............................
show all

jgrasp handbook

You also want an ePaper? Increase the reach of your titles

Delete template?

Save as template?