diff options
Diffstat (limited to 'Documentation/CodingStyle')
| -rw-r--r-- | Documentation/CodingStyle | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/Documentation/CodingStyle b/Documentation/CodingStyle index cb9258b8fd35..495e5ba1634c 100644 --- a/Documentation/CodingStyle +++ b/Documentation/CodingStyle | |||
| @@ -454,6 +454,16 @@ The preferred style for long (multi-line) comments is: | |||
| 454 | * with beginning and ending almost-blank lines. | 454 | * with beginning and ending almost-blank lines. |
| 455 | */ | 455 | */ |
| 456 | 456 | ||
| 457 | For files in net/ and drivers/net/ the preferred style for long (multi-line) | ||
| 458 | comments is a little different. | ||
| 459 | |||
| 460 | /* The preferred comment style for files in net/ and drivers/net | ||
| 461 | * looks like this. | ||
| 462 | * | ||
| 463 | * It is nearly the same as the generally preferred comment style, | ||
| 464 | * but there is no initial almost-blank line. | ||
| 465 | */ | ||
| 466 | |||
| 457 | It's also important to comment data, whether they are basic types or derived | 467 | It's also important to comment data, whether they are basic types or derived |
| 458 | types. To this end, use just one data declaration per line (no commas for | 468 | types. To this end, use just one data declaration per line (no commas for |
| 459 | multiple data declarations). This leaves you room for a small comment on each | 469 | multiple data declarations). This leaves you room for a small comment on each |
