8 |
This document attempts to give a brief guide on how to write |
This document attempts to give a brief guide on how to write |
9 |
Java code for this project. |
Java code for this project. |
10 |
|
|
11 |
|
Rules |
12 |
|
----- |
13 |
|
|
14 |
- each Java file should contain the boilerplate copyright and |
- each Java file should contain the boilerplate copyright and |
15 |
license notice (see e.g. gzz/Cell.java). |
license notice (see e.g. gzz/Cell.java). |
16 |
|
|
124 |
- make your code such that it can be compiled in jikes +P (pedantic), |
- make your code such that it can be compiled in jikes +P (pedantic), |
125 |
JDK1.1.8 and JDK1.2.2 without warnings or errors. |
JDK1.1.8 and JDK1.2.2 without warnings or errors. |
126 |
|
|
127 |
- as an aside, I really recommend using a coloring editor since there are |
Tips (for speeding up work) |
128 |
|
--------------------------- |
129 |
|
|
130 |
|
- I really recommend using a coloring editor since there are |
131 |
many points where significant sections have been commented out. This |
many points where significant sections have been commented out. This |
132 |
is bad practice but inevitable in a system that doesn't easily allow |
is bad practice but inevitable in a system that doesn't easily allow |
133 |
us to attach the sections which are not useful now but might be later |
us to attach the sections which are not useful now but might be later |
134 |
to the text in a xanadu-like manner. |
to the text in a xanadu-like manner. |
135 |
|
|
136 |
|
- We use pretty long identifiers - make sure your editor's dynamic |
137 |
|
abbreviations are turned on. For example, I type |
138 |
|
Mod^P |
139 |
|
and start getting the options |
140 |
|
ModularSpace, ... |
141 |
|
for the word. NEVER type the identifiers in whole. |
142 |
|
|
143 |
|
- Use exuberant ctags. First, "make tags", then in vim, I |
144 |
|
just do |
145 |
|
:ta Aff<TAB> |
146 |
|
which gives me the options AffineVobCoorder and AffineXYCoords. |
147 |
|
Then, pressing enter takes me to the definition. |
148 |
|
NEVER type the directory names for the classes. |
149 |
|
|