On Wed, 27 Jul 2022 23:44:04 -0400, Wayne wrote:
IME and IMO too, a good start for writing any Java class is to create a document, which should be held in a directory hierarchy where it will be
once its content has been expanded to contain executable Java code. It
should contain:
- a class-level comment describing the purpose of the class and anything
else somebody using it should know about the class as a whole. This
should be followed by a skeletal class definition, i.e. the class
declaration, which should include constants defined and exposed by the
class and possibly some of the more important class-level variables it
contains.
- the class body should contain declarations of the public methods the
class exposes, each preceded by a method-level comment describing the
method's function and anything else a caller should know about its call
parameters and return value.
- the document header should include the package declaration and any
'import' statements needed for it to compile.
- this class definition must compile and produce clean, easily readable
and understandable output when run through javadoc.
...
On Wed, 27 Jul 2022 23:44:04 -0400, Wayne wrote:
IME and IMO too, a good start for writing any Java class is to create a document, which should be held in a directory hierarchy where it will be once its content has been expanded to contain executable Java code. It should contain:
Sysop: | Keyop |
---|---|
Location: | Huddersfield, West Yorkshire, UK |
Users: | 300 |
Nodes: | 16 (2 / 14) |
Uptime: | 73:10:11 |
Calls: | 6,714 |
Calls today: | 2 |
Files: | 12,246 |
Messages: | 5,357,168 |