1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
|
Block-level Javadoc tags like @param, @return, @throws, and @deprecated are
meant to provide additional information about the method. Without a description
they are no more informative than the method signature and should be removed.
Either add a description after the tag, or delete the low-information tag.
### @throws
```java
interface Test {
/**
* @throws StorageException
*/
void write() throws StorageException;
}
```
```java
interface Test {
/**
* @throws StorageException when unable to write to storage
*/
void write() throws StorageException;
}
```
```java
interface Test {
void write() throws StorageException;
}
```
### @param
```java
interface Test {
/**
* Does a foo.
*
* @param p
*/
void foo(int p);
}
```
```java
interface Test {
/**
* Does a foo.
*
* @param count How many knobs to turn
*/
void foo(int count);
}
```
```java
interface Test {
/**
* Does a foo.
*/
void foo(int count);
}
```
## Suppression
Suppress by applying `@SuppressWarnings("EmptyBlockTag")` to the element being
documented.
|
