123 |
- If method implements an interface it's javadocced by the interface. |
- If method implements an interface it's javadocced by the interface. |
124 |
So, don't make any worse documentation in implementation, leave it |
So, don't make any worse documentation in implementation, leave it |
125 |
alone or mark it with comment // javadoc in interface etc. |
alone or mark it with comment // javadoc in interface etc. |
126 |
|
- Some helpful questions which you can answer in the doc: |
127 |
|
|
128 |
|
- How does other classes use this? |
129 |
|
|
130 |
|
- Who calls it? |
131 |
|
- What for? |
132 |
|
- When? |
133 |
|
- How many instances are there of this class? |
134 |
|
- What is it used to represent? |
135 |
|
- What different implementations can there be? |
136 |
|
- Would a good example hurt? |
137 |
|
|
138 |
4. Test |
4. Test |
139 |
|
|