File tree Expand file tree Collapse file tree 1 file changed +10
-8
lines changed Expand file tree Collapse file tree 1 file changed +10
-8
lines changed Original file line number Diff line number Diff line change @@ -405,25 +405,27 @@ name clashes.
405
405
406
406
* Endeavor to make your code as self-documenting as possible.
407
407
408
- * Write heading comments with at least four semicolons.
408
+ * Write heading comments with at least three semicolons.
409
409
410
- * Write top-level comments with three semicolons.
410
+ * Write top-level comments with three semicolons if it represents a
411
+ heading, otherwise use two semicolons.
411
412
412
413
* Write comments on a particular fragment of code before that fragment
413
- and aligned with it, using two semicolons.
414
+ and aligned with it, using two semicolons.
414
415
415
416
* Write margin comments with one semicolon.
416
417
417
418
* Always have at least one space between the semicolon
418
419
and the text that follows it.
419
420
420
421
```el
421
- ;;;; Frob Grovel
422
+ ;;; Frob Grovel
423
+ ;; This is where Frob grovels and where Grovel frobs.
422
424
423
- ;;; This section of code has some important implications:
424
- ;;; 1. Foo.
425
- ;;; 2. Bar.
426
- ;;; 3. Baz.
425
+ ;; This section of code has some important implications:
426
+ ;; 1. Foo.
427
+ ;; 2. Bar.
428
+ ;; 3. Baz.
427
429
428
430
(defun fnord (zarquon)
429
431
;; If zob, then veeblefitz.
You can’t perform that action at this time.
0 commit comments