Mercurial > emacs
annotate lispref/tips.texi @ 36606:a72b3da04728
(which-func-modes): Add cperl-mode.
(which-func-mode-global): Use define-minor-mode.
author | Stefan Monnier <monnier@iro.umontreal.ca> |
---|---|
date | Tue, 06 Mar 2001 23:47:40 +0000 |
parents | 0c60b76ea2ee |
children | 3577e0c41a1e |
rev | line source |
---|---|
6552 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
27189 | 3 @c Copyright (C) 1990, 1991, 1992, 1993, 1995, 1998, 1999 |
4 @c Free Software Foundation, Inc. | |
6552 | 5 @c See the file elisp.texi for copying conditions. |
6 @setfilename ../info/tips | |
30904 | 7 @node Tips, GNU Emacs Internals, GPL, Top |
17280
96762d1abb7c
(Coding Conventions): Node renamed from Style Tips.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
8 @appendix Tips and Conventions |
6552 | 9 @cindex tips |
10 @cindex standards of coding style | |
11 @cindex coding standards | |
12 | |
17280
96762d1abb7c
(Coding Conventions): Node renamed from Style Tips.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
13 This chapter describes no additional features of Emacs Lisp. Instead |
96762d1abb7c
(Coding Conventions): Node renamed from Style Tips.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
14 it gives advice on making effective use of the features described in the |
96762d1abb7c
(Coding Conventions): Node renamed from Style Tips.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
15 previous chapters, and describes conventions Emacs Lisp programmers |
96762d1abb7c
(Coding Conventions): Node renamed from Style Tips.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
16 should follow. |
6552 | 17 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
18 You can automatically check some of the conventions described below by |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
19 running the command @kbd{M-x checkdoc RET} when visiting a Lisp file. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
20 It cannot check all of the conventions, and not all the warnings it |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
21 gives necessarily correspond to problems, but it is worth examining them |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
22 all. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
23 |
6552 | 24 @menu |
17280
96762d1abb7c
(Coding Conventions): Node renamed from Style Tips.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
25 * Coding Conventions:: Conventions for clean and robust programs. |
6552 | 26 * Compilation Tips:: Making compiled code run fast. |
27 * Documentation Tips:: Writing readable documentation strings. | |
28 * Comment Tips:: Conventions for writing comments. | |
29 * Library Headers:: Standard headers for library packages. | |
30 @end menu | |
31 | |
17280
96762d1abb7c
(Coding Conventions): Node renamed from Style Tips.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
32 @node Coding Conventions |
96762d1abb7c
(Coding Conventions): Node renamed from Style Tips.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
33 @section Emacs Lisp Coding Conventions |
6552 | 34 |
17280
96762d1abb7c
(Coding Conventions): Node renamed from Style Tips.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
35 Here are conventions that you should follow when writing Emacs Lisp |
96762d1abb7c
(Coding Conventions): Node renamed from Style Tips.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
36 code intended for widespread use: |
6552 | 37 |
38 @itemize @bullet | |
39 @item | |
40 Since all global variables share the same name space, and all functions | |
41 share another name space, you should choose a short word to distinguish | |
34305 | 42 your program from other Lisp programs.@footnote{The benefits of a Common |
43 Lisp-style package system are considered not to outweigh the costs.} | |
44 Then take care to begin the names of all global variables, constants, | |
45 and functions with the chosen prefix. This helps avoid name conflicts. | |
6552 | 46 |
47 This recommendation applies even to names for traditional Lisp | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
48 primitives that are not primitives in Emacs Lisp---even to |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
49 @code{copy-list}. Believe it or not, there is more than one plausible |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
50 way to define @code{copy-list}. Play it safe; append your name prefix |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
51 to produce a name like @code{foo-copy-list} or @code{mylib-copy-list} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
52 instead. |
6552 | 53 |
54 If you write a function that you think ought to be added to Emacs under | |
55 a certain name, such as @code{twiddle-files}, don't call it by that name | |
56 in your program. Call it @code{mylib-twiddle-files} in your program, | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
57 and send mail to @samp{bug-gnu-emacs@@gnu.org} suggesting we add |
6552 | 58 it to Emacs. If and when we do, we can change the name easily enough. |
59 | |
60 If one prefix is insufficient, your package may use two or three | |
61 alternative common prefixes, so long as they make sense. | |
62 | |
63 Separate the prefix from the rest of the symbol name with a hyphen, | |
64 @samp{-}. This will be consistent with Emacs itself and with most Emacs | |
65 Lisp programs. | |
66 | |
67 @item | |
68 It is often useful to put a call to @code{provide} in each separate | |
69 library program, at least if there is more than one entry point to the | |
70 program. | |
71 | |
72 @item | |
12098 | 73 If a file requires certain other library programs to be loaded |
74 beforehand, then the comments at the beginning of the file should say | |
75 so. Also, use @code{require} to make sure they are loaded. | |
76 | |
77 @item | |
6552 | 78 If one file @var{foo} uses a macro defined in another file @var{bar}, |
12098 | 79 @var{foo} should contain this expression before the first use of the |
80 macro: | |
81 | |
82 @example | |
83 (eval-when-compile (require '@var{bar})) | |
84 @end example | |
85 | |
86 @noindent | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
87 (And the library @var{bar} should contain @code{(provide '@var{bar})}, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
88 to make the @code{require} work.) This will cause @var{bar} to be |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
89 loaded when you byte-compile @var{foo}. Otherwise, you risk compiling |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
90 @var{foo} without the necessary macro loaded, and that would produce |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
91 compiled code that won't work right. @xref{Compiling Macros}. |
12098 | 92 |
93 Using @code{eval-when-compile} avoids loading @var{bar} when | |
94 the compiled version of @var{foo} is @emph{used}. | |
6552 | 95 |
96 @item | |
24799 | 97 Please don't require the @code{cl} package of Common Lisp extensions at |
98 run time. Use of this package is optional, and it is not part of the | |
99 standard Emacs namespace. If your package loads @code{cl} at run time, | |
100 that could cause name clashes for users who don't use that package. | |
101 | |
102 However, there is no problem with using the @code{cl} package at compile | |
103 time, for the sake of macros. You do that like this: | |
104 | |
105 @example | |
106 (eval-when-compile (require 'cl)) | |
107 @end example | |
108 | |
109 @item | |
17280
96762d1abb7c
(Coding Conventions): Node renamed from Style Tips.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
110 When defining a major mode, please follow the major mode |
96762d1abb7c
(Coding Conventions): Node renamed from Style Tips.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
111 conventions. @xref{Major Mode Conventions}. |
96762d1abb7c
(Coding Conventions): Node renamed from Style Tips.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
112 |
96762d1abb7c
(Coding Conventions): Node renamed from Style Tips.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
113 @item |
96762d1abb7c
(Coding Conventions): Node renamed from Style Tips.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
114 When defining a minor mode, please follow the minor mode |
96762d1abb7c
(Coding Conventions): Node renamed from Style Tips.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
115 conventions. @xref{Minor Mode Conventions}. |
6552 | 116 |
117 @item | |
9807
d5fa87d62d62
Add function and variable name conventions.
Richard M. Stallman <rms@gnu.org>
parents:
9393
diff
changeset
|
118 If the purpose of a function is to tell you whether a certain condition |
d5fa87d62d62
Add function and variable name conventions.
Richard M. Stallman <rms@gnu.org>
parents:
9393
diff
changeset
|
119 is true or false, give the function a name that ends in @samp{p}. If |
d5fa87d62d62
Add function and variable name conventions.
Richard M. Stallman <rms@gnu.org>
parents:
9393
diff
changeset
|
120 the name is one word, add just @samp{p}; if the name is multiple words, |
d5fa87d62d62
Add function and variable name conventions.
Richard M. Stallman <rms@gnu.org>
parents:
9393
diff
changeset
|
121 add @samp{-p}. Examples are @code{framep} and @code{frame-live-p}. |
d5fa87d62d62
Add function and variable name conventions.
Richard M. Stallman <rms@gnu.org>
parents:
9393
diff
changeset
|
122 |
d5fa87d62d62
Add function and variable name conventions.
Richard M. Stallman <rms@gnu.org>
parents:
9393
diff
changeset
|
123 @item |
d5fa87d62d62
Add function and variable name conventions.
Richard M. Stallman <rms@gnu.org>
parents:
9393
diff
changeset
|
124 If a user option variable records a true-or-false condition, give it a |
d5fa87d62d62
Add function and variable name conventions.
Richard M. Stallman <rms@gnu.org>
parents:
9393
diff
changeset
|
125 name that ends in @samp{-flag}. |
d5fa87d62d62
Add function and variable name conventions.
Richard M. Stallman <rms@gnu.org>
parents:
9393
diff
changeset
|
126 |
d5fa87d62d62
Add function and variable name conventions.
Richard M. Stallman <rms@gnu.org>
parents:
9393
diff
changeset
|
127 @item |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
128 @cindex reserved keys |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
129 @cindex keys, reserved |
6552 | 130 Please do not define @kbd{C-c @var{letter}} as a key in your major |
131 modes. These sequences are reserved for users; they are the | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
132 @strong{only} sequences reserved for users, so do not block them. |
6552 | 133 |
14394
289506921917
Clarify key sequence usage conventions.
Richard M. Stallman <rms@gnu.org>
parents:
14028
diff
changeset
|
134 Instead, define sequences consisting of @kbd{C-c} followed by a control |
289506921917
Clarify key sequence usage conventions.
Richard M. Stallman <rms@gnu.org>
parents:
14028
diff
changeset
|
135 character, a digit, or certain punctuation characters. These sequences |
289506921917
Clarify key sequence usage conventions.
Richard M. Stallman <rms@gnu.org>
parents:
14028
diff
changeset
|
136 are reserved for major modes. |
6552 | 137 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
138 Changing all the Emacs major modes to follow this convention was a lot |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
139 of work. Abandoning this convention would make that work go to waste, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
140 and inconvenience users. |
11648
e09e51d7c35a
Describe uses of C-c followed by punctuation chars.
Richard M. Stallman <rms@gnu.org>
parents:
10229
diff
changeset
|
141 |
e09e51d7c35a
Describe uses of C-c followed by punctuation chars.
Richard M. Stallman <rms@gnu.org>
parents:
10229
diff
changeset
|
142 @item |
e09e51d7c35a
Describe uses of C-c followed by punctuation chars.
Richard M. Stallman <rms@gnu.org>
parents:
10229
diff
changeset
|
143 Sequences consisting of @kbd{C-c} followed by @kbd{@{}, @kbd{@}}, |
e09e51d7c35a
Describe uses of C-c followed by punctuation chars.
Richard M. Stallman <rms@gnu.org>
parents:
10229
diff
changeset
|
144 @kbd{<}, @kbd{>}, @kbd{:} or @kbd{;} are also reserved for major modes. |
e09e51d7c35a
Describe uses of C-c followed by punctuation chars.
Richard M. Stallman <rms@gnu.org>
parents:
10229
diff
changeset
|
145 |
e09e51d7c35a
Describe uses of C-c followed by punctuation chars.
Richard M. Stallman <rms@gnu.org>
parents:
10229
diff
changeset
|
146 @item |
e09e51d7c35a
Describe uses of C-c followed by punctuation chars.
Richard M. Stallman <rms@gnu.org>
parents:
10229
diff
changeset
|
147 Sequences consisting of @kbd{C-c} followed by any other punctuation |
e09e51d7c35a
Describe uses of C-c followed by punctuation chars.
Richard M. Stallman <rms@gnu.org>
parents:
10229
diff
changeset
|
148 character are allocated for minor modes. Using them in a major mode is |
e09e51d7c35a
Describe uses of C-c followed by punctuation chars.
Richard M. Stallman <rms@gnu.org>
parents:
10229
diff
changeset
|
149 not absolutely prohibited, but if you do that, the major mode binding |
e09e51d7c35a
Describe uses of C-c followed by punctuation chars.
Richard M. Stallman <rms@gnu.org>
parents:
10229
diff
changeset
|
150 may be shadowed from time to time by minor modes. |
6552 | 151 |
152 @item | |
19361
8546df4cb304
Reserve some function keys for users.
Richard M. Stallman <rms@gnu.org>
parents:
17280
diff
changeset
|
153 Function keys @key{F5} through @key{F9} without modifier keys are |
8546df4cb304
Reserve some function keys for users.
Richard M. Stallman <rms@gnu.org>
parents:
17280
diff
changeset
|
154 reserved for users to define. |
8546df4cb304
Reserve some function keys for users.
Richard M. Stallman <rms@gnu.org>
parents:
17280
diff
changeset
|
155 |
8546df4cb304
Reserve some function keys for users.
Richard M. Stallman <rms@gnu.org>
parents:
17280
diff
changeset
|
156 @item |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
157 Do not bind @kbd{C-h} following any prefix character (including |
6552 | 158 @kbd{C-c}). If you don't bind @kbd{C-h}, it is automatically available |
159 as a help character for listing the subcommands of the prefix character. | |
160 | |
161 @item | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
162 Do not bind a key sequence ending in @key{ESC} except following |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
163 another @key{ESC}. (That is, it is OK to bind a sequence ending in |
6552 | 164 @kbd{@key{ESC} @key{ESC}}.) |
165 | |
166 The reason for this rule is that a non-prefix binding for @key{ESC} in | |
167 any context prevents recognition of escape sequences as function keys in | |
168 that context. | |
169 | |
170 @item | |
22635
1e9786a5c63d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
171 Anything which acts like a temporary mode or state which the user can |
24862 | 172 enter and leave should define @kbd{@key{ESC} @key{ESC}} or |
22635
1e9786a5c63d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
173 @kbd{@key{ESC} @key{ESC} @key{ESC}} as a way to escape. |
1e9786a5c63d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
174 |
1e9786a5c63d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
175 For a state which accepts ordinary Emacs commands, or more generally any |
1e9786a5c63d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
176 kind of state in which @key{ESC} followed by a function key or arrow key |
1e9786a5c63d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
177 is potentially meaningful, then you must not define @kbd{@key{ESC} |
1e9786a5c63d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
178 @key{ESC}}, since that would preclude recognizing an escape sequence |
1e9786a5c63d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
179 after @key{ESC}. In these states, you should define @kbd{@key{ESC} |
1e9786a5c63d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
180 @key{ESC} @key{ESC}} as the way to escape. Otherwise, define |
1e9786a5c63d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
181 @kbd{@key{ESC} @key{ESC}} instead. |
1e9786a5c63d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
182 |
1e9786a5c63d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
183 @item |
6959
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
184 Applications should not bind mouse events based on button 1 with the |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
185 shift key held down. These events include @kbd{S-mouse-1}, |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
186 @kbd{M-S-mouse-1}, @kbd{C-S-mouse-1}, and so on. They are reserved for |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
187 users. |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
188 |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
189 @item |
34305 | 190 @cindex mouse-2 |
191 @cindex references, following | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
192 Special major modes used for read-only text should usually redefine |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
193 @kbd{mouse-2} and @key{RET} to trace some sort of reference in the text. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
194 Modes such as Dired, Info, Compilation, and Occur redefine it in this |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
195 way. |
6959
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
196 |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
197 @item |
9393
0bec3b6bac2f
Add a tip about enabling/disabling features.
Richard M. Stallman <rms@gnu.org>
parents:
8669
diff
changeset
|
198 When a package provides a modification of ordinary Emacs behavior, it is |
0bec3b6bac2f
Add a tip about enabling/disabling features.
Richard M. Stallman <rms@gnu.org>
parents:
8669
diff
changeset
|
199 good to include a command to enable and disable the feature, Provide a |
0bec3b6bac2f
Add a tip about enabling/disabling features.
Richard M. Stallman <rms@gnu.org>
parents:
8669
diff
changeset
|
200 command named @code{@var{whatever}-mode} which turns the feature on or |
0bec3b6bac2f
Add a tip about enabling/disabling features.
Richard M. Stallman <rms@gnu.org>
parents:
8669
diff
changeset
|
201 off, and make it autoload (@pxref{Autoload}). Design the package so |
0bec3b6bac2f
Add a tip about enabling/disabling features.
Richard M. Stallman <rms@gnu.org>
parents:
8669
diff
changeset
|
202 that simply loading it has no visible effect---that should not enable |
34305 | 203 the feature.@footnote{Consider that the package may be loaded |
204 arbitrarily by Custom for instance.} Users will request the feature by | |
205 invoking the command. | |
9393
0bec3b6bac2f
Add a tip about enabling/disabling features.
Richard M. Stallman <rms@gnu.org>
parents:
8669
diff
changeset
|
206 |
0bec3b6bac2f
Add a tip about enabling/disabling features.
Richard M. Stallman <rms@gnu.org>
parents:
8669
diff
changeset
|
207 @item |
0bec3b6bac2f
Add a tip about enabling/disabling features.
Richard M. Stallman <rms@gnu.org>
parents:
8669
diff
changeset
|
208 It is a bad idea to define aliases for the Emacs primitives. Use the |
0bec3b6bac2f
Add a tip about enabling/disabling features.
Richard M. Stallman <rms@gnu.org>
parents:
8669
diff
changeset
|
209 standard names instead. |
6552 | 210 |
211 @item | |
34305 | 212 If a package needs to define an alias or a new function for |
213 compatibility with some other version of Emacs, name if with the package | |
214 prefix, not with the raw name with which it occurs in the other version. | |
215 Here is an example from Gnus, which provides many examples of such | |
216 compatibility issues. | |
217 | |
218 @example | |
219 (defalias 'gnus-point-at-bol | |
220 (if (fboundp 'point-at-bol) | |
221 'point-at-bol | |
222 'line-beginning-position)) | |
223 @end example | |
224 | |
225 @item | |
17280
96762d1abb7c
(Coding Conventions): Node renamed from Style Tips.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
226 Redefining (or advising) an Emacs primitive is discouraged. It may do |
96762d1abb7c
(Coding Conventions): Node renamed from Style Tips.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
227 the right thing for a particular program, but there is no telling what |
96762d1abb7c
(Coding Conventions): Node renamed from Style Tips.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
228 other programs might break as a result. |
6552 | 229 |
230 @item | |
231 If a file does replace any of the functions or library programs of | |
232 standard Emacs, prominent comments at the beginning of the file should | |
233 say which functions are replaced, and how the behavior of the | |
234 replacements differs from that of the originals. | |
235 | |
236 @item | |
237 Please keep the names of your Emacs Lisp source files to 13 characters | |
238 or less. This way, if the files are compiled, the compiled files' names | |
239 will be 14 characters or less, which is short enough to fit on all kinds | |
240 of Unix systems. | |
241 | |
242 @item | |
243 Don't use @code{next-line} or @code{previous-line} in programs; nearly | |
244 always, @code{forward-line} is more convenient as well as more | |
245 predictable and robust. @xref{Text Lines}. | |
246 | |
247 @item | |
7601
c5927c75b2b5
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6959
diff
changeset
|
248 Don't call functions that set the mark, unless setting the mark is one |
c5927c75b2b5
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6959
diff
changeset
|
249 of the intended features of your program. The mark is a user-level |
c5927c75b2b5
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6959
diff
changeset
|
250 feature, so it is incorrect to change the mark except to supply a value |
c5927c75b2b5
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6959
diff
changeset
|
251 for the user's benefit. @xref{The Mark}. |
6552 | 252 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
253 In particular, don't use any of these functions: |
6552 | 254 |
255 @itemize @bullet | |
256 @item | |
257 @code{beginning-of-buffer}, @code{end-of-buffer} | |
258 @item | |
259 @code{replace-string}, @code{replace-regexp} | |
260 @end itemize | |
261 | |
262 If you just want to move point, or replace a certain string, without any | |
263 of the other features intended for interactive users, you can replace | |
264 these functions with one or two lines of simple Lisp code. | |
265 | |
266 @item | |
8669 | 267 Use lists rather than vectors, except when there is a particular reason |
268 to use a vector. Lisp has more facilities for manipulating lists than | |
269 for vectors, and working with lists is usually more convenient. | |
270 | |
271 Vectors are advantageous for tables that are substantial in size and are | |
272 accessed in random order (not searched front to back), provided there is | |
273 no need to insert or delete elements (only lists allow that). | |
274 | |
275 @item | |
6552 | 276 The recommended way to print a message in the echo area is with |
277 the @code{message} function, not @code{princ}. @xref{The Echo Area}. | |
278 | |
279 @item | |
280 When you encounter an error condition, call the function @code{error} | |
281 (or @code{signal}). The function @code{error} does not return. | |
282 @xref{Signaling Errors}. | |
283 | |
284 Do not use @code{message}, @code{throw}, @code{sleep-for}, | |
285 or @code{beep} to report errors. | |
286 | |
287 @item | |
12098 | 288 An error message should start with a capital letter but should not end |
289 with a period. | |
290 | |
291 @item | |
13893
2576d1142ed3
Explain style of "done" messages.
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
292 Many commands that take a long time to execute display a message that |
2576d1142ed3
Explain style of "done" messages.
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
293 says @samp{Operating...} when they start, and change it to |
2576d1142ed3
Explain style of "done" messages.
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
294 @samp{Operating...done} when they finish. Please keep the style of |
2576d1142ed3
Explain style of "done" messages.
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
295 these messages uniform: @emph{no} space around the ellipsis, and |
2576d1142ed3
Explain style of "done" messages.
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
296 @emph{no} period at the end. |
2576d1142ed3
Explain style of "done" messages.
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
297 |
2576d1142ed3
Explain style of "done" messages.
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
298 @item |
6959
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
299 Try to avoid using recursive edits. Instead, do what the Rmail @kbd{e} |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
300 command does: use a new local keymap that contains one command defined |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
301 to switch back to the old local keymap. Or do what the |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
302 @code{edit-options} command does: switch to another buffer and let the |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
303 user switch back at will. @xref{Recursive Editing}. |
6552 | 304 |
305 @item | |
306 In some other systems there is a convention of choosing variable names | |
307 that begin and end with @samp{*}. We don't use that convention in Emacs | |
6959
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
308 Lisp, so please don't use it in your programs. (Emacs uses such names |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
309 only for special-purpose buffers.) The users will find Emacs more |
6959
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
310 coherent if all libraries use the same conventions. |
6552 | 311 |
312 @item | |
14028
e8d6c760f796
Explain eliminating compiler warnings about undefined variables.
Richard M. Stallman <rms@gnu.org>
parents:
13893
diff
changeset
|
313 Try to avoid compiler warnings about undefined free variables, by adding |
15198 | 314 @code{defvar} definitions for these variables. |
14028
e8d6c760f796
Explain eliminating compiler warnings about undefined variables.
Richard M. Stallman <rms@gnu.org>
parents:
13893
diff
changeset
|
315 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
316 Sometimes adding a @code{require} for another package is useful to avoid |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
317 compilation warnings for variables and functions defined in that |
26211 | 318 package. If you do this, often it is better if the @code{require} acts |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
319 only at compile time. Here's how to do that: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
320 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
321 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
322 (eval-when-compile |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
323 (require 'foo) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
324 (defvar bar-baz)) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
325 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
326 |
14028
e8d6c760f796
Explain eliminating compiler warnings about undefined variables.
Richard M. Stallman <rms@gnu.org>
parents:
13893
diff
changeset
|
327 If you bind a variable in one function, and use it or set it in another |
e8d6c760f796
Explain eliminating compiler warnings about undefined variables.
Richard M. Stallman <rms@gnu.org>
parents:
13893
diff
changeset
|
328 function, the compiler warns about the latter function unless the |
e8d6c760f796
Explain eliminating compiler warnings about undefined variables.
Richard M. Stallman <rms@gnu.org>
parents:
13893
diff
changeset
|
329 variable has a definition. But often these variables have short names, |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
330 and it is not clean for Lisp packages to define such variable names. |
14028
e8d6c760f796
Explain eliminating compiler warnings about undefined variables.
Richard M. Stallman <rms@gnu.org>
parents:
13893
diff
changeset
|
331 Therefore, you should rename the variable to start with the name prefix |
e8d6c760f796
Explain eliminating compiler warnings about undefined variables.
Richard M. Stallman <rms@gnu.org>
parents:
13893
diff
changeset
|
332 used for the other functions and variables in your package. |
e8d6c760f796
Explain eliminating compiler warnings about undefined variables.
Richard M. Stallman <rms@gnu.org>
parents:
13893
diff
changeset
|
333 |
e8d6c760f796
Explain eliminating compiler warnings about undefined variables.
Richard M. Stallman <rms@gnu.org>
parents:
13893
diff
changeset
|
334 @item |
6552 | 335 Indent each function with @kbd{C-M-q} (@code{indent-sexp}) using the |
336 default indentation parameters. | |
337 | |
338 @item | |
339 Don't make a habit of putting close-parentheses on lines by themselves; | |
340 Lisp programmers find this disconcerting. Once in a while, when there | |
341 is a sequence of many consecutive close-parentheses, it may make sense | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
342 to split the sequence in one or two significant places. |
6552 | 343 |
344 @item | |
345 Please put a copyright notice on the file if you give copies to anyone. | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
346 Use a message like this one: |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
347 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
348 @smallexample |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
349 ;; Copyright (C) @var{year} @var{name} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
350 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
351 ;; This program is free software; you can redistribute it and/or |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
352 ;; modify it under the terms of the GNU General Public License as |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
353 ;; published by the Free Software Foundation; either version 2 of |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
354 ;; the License, or (at your option) any later version. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
355 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
356 ;; This program is distributed in the hope that it will be |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
357 ;; useful, but WITHOUT ANY WARRANTY; without even the implied |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
358 ;; warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
359 ;; PURPOSE. See the GNU General Public License for more details. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
360 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
361 ;; You should have received a copy of the GNU General Public |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
362 ;; License along with this program; if not, write to the Free |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
363 ;; Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
364 ;; MA 02111-1307 USA |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
365 @end smallexample |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
366 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
367 If you have signed papers to assign the copyright to the Foundation, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
368 then use @samp{Free Software Foundation, Inc.} as @var{name}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
369 Otherwise, use your name. |
6552 | 370 @end itemize |
371 | |
372 @node Compilation Tips | |
373 @section Tips for Making Compiled Code Fast | |
374 @cindex execution speed | |
375 @cindex speedups | |
376 | |
377 Here are ways of improving the execution speed of byte-compiled | |
6959
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
378 Lisp programs. |
6552 | 379 |
380 @itemize @bullet | |
381 @item | |
382 @cindex profiling | |
383 @cindex timing programs | |
384 @cindex @file{profile.el} | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
385 @cindex @file{elp.el} |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
386 Profile your program with the @file{profile} library or the @file{elp} |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
387 library. See the files @file{profile.el} and @file{elp.el} for |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
388 instructions. |
6552 | 389 |
390 @item | |
391 Use iteration rather than recursion whenever possible. | |
392 Function calls are slow in Emacs Lisp even when a compiled function | |
393 is calling another compiled function. | |
394 | |
395 @item | |
12098 | 396 Using the primitive list-searching functions @code{memq}, @code{member}, |
397 @code{assq}, or @code{assoc} is even faster than explicit iteration. It | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
398 can be worth rearranging a data structure so that one of these primitive |
12098 | 399 search functions can be used. |
6552 | 400 |
401 @item | |
6959
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
402 Certain built-in functions are handled specially in byte-compiled code, |
6552 | 403 avoiding the need for an ordinary function call. It is a good idea to |
404 use these functions rather than alternatives. To see whether a function | |
405 is handled specially by the compiler, examine its @code{byte-compile} | |
406 property. If the property is non-@code{nil}, then the function is | |
407 handled specially. | |
408 | |
409 For example, the following input will show you that @code{aref} is | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
410 compiled specially (@pxref{Array Functions}): |
6552 | 411 |
6959
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
412 @example |
6552 | 413 @group |
414 (get 'aref 'byte-compile) | |
415 @result{} byte-compile-two-args | |
416 @end group | |
6959
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
417 @end example |
6552 | 418 |
419 @item | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
420 If calling a small function accounts for a substantial part of your |
6552 | 421 program's running time, make the function inline. This eliminates |
422 the function call overhead. Since making a function inline reduces | |
423 the flexibility of changing the program, don't do it unless it gives | |
6959
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
424 a noticeable speedup in something slow enough that users care about |
6552 | 425 the speed. @xref{Inline Functions}. |
426 @end itemize | |
427 | |
428 @node Documentation Tips | |
429 @section Tips for Documentation Strings | |
430 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
431 @findex checkdoc-minor-mode |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
432 Here are some tips and conventions for the writing of documentation |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
433 strings. You can check many of these conventions by running the command |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
434 @kbd{M-x checkdoc-minor-mode}. |
6552 | 435 |
436 @itemize @bullet | |
437 @item | |
7601
c5927c75b2b5
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6959
diff
changeset
|
438 Every command, function, or variable intended for users to know about |
6552 | 439 should have a documentation string. |
440 | |
441 @item | |
10225
2e5dcd5f3090
Recommend doc strings for all functions and variables.
Richard M. Stallman <rms@gnu.org>
parents:
9807
diff
changeset
|
442 An internal variable or subroutine of a Lisp program might as well have |
2e5dcd5f3090
Recommend doc strings for all functions and variables.
Richard M. Stallman <rms@gnu.org>
parents:
9807
diff
changeset
|
443 a documentation string. In earlier Emacs versions, you could save space |
2e5dcd5f3090
Recommend doc strings for all functions and variables.
Richard M. Stallman <rms@gnu.org>
parents:
9807
diff
changeset
|
444 by using a comment instead of a documentation string, but that is no |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
445 longer the case---documentation strings now take up very little space in |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
446 a running Emacs. |
6552 | 447 |
448 @item | |
449 The first line of the documentation string should consist of one or two | |
7601
c5927c75b2b5
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6959
diff
changeset
|
450 complete sentences that stand on their own as a summary. @kbd{M-x |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
451 apropos} displays just the first line, and if that line's contents don't |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
452 stand on their own, the result looks bad. In particular, start the |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
453 first line with a capital letter and end with a period. |
6552 | 454 |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
455 The documentation string is not limited to one line; use as many lines |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
456 as you need to explain the details of how to use the function or |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
457 variable. Please use complete sentences in the additional lines. |
6552 | 458 |
459 @item | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
460 For consistency, phrase the verb in the first sentence of a function's |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
461 documentation string as an imperative--for instance, use ``Return the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
462 cons of A and B.'' in preference to ``Returns the cons of A and B@.'' |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
463 Usually it looks good to do likewise for the rest of the first |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
464 paragraph. Subsequent paragraphs usually look better if each sentence |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
465 has a proper subject. |
6959
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
466 |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
467 @item |
6552 | 468 Write documentation strings in the active voice, not the passive, and in |
469 the present tense, not the future. For instance, use ``Return a list | |
470 containing A and B.'' instead of ``A list containing A and B will be | |
471 returned.'' | |
472 | |
473 @item | |
474 Avoid using the word ``cause'' (or its equivalents) unnecessarily. | |
475 Instead of, ``Cause Emacs to display text in boldface,'' write just | |
476 ``Display text in boldface.'' | |
477 | |
478 @item | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
479 When a command is meaningful only in a certain mode or situation, |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
480 do mention that in the documentation string. For example, |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
481 the documentation of @code{dired-find-file} is: |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
482 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
483 @example |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
484 In Dired, visit the file or directory named on this line. |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
485 @end example |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
486 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
487 @item |
6552 | 488 Do not start or end a documentation string with whitespace. |
489 | |
490 @item | |
491 Format the documentation string so that it fits in an Emacs window on an | |
7601
c5927c75b2b5
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6959
diff
changeset
|
492 80-column screen. It is a good idea for most lines to be no wider than |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
493 60 characters. The first line should not be wider than 67 characters |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
494 or it will look bad in the output of @code{apropos}. |
6552 | 495 |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
496 You can fill the text if that looks good. However, rather than blindly |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
497 filling the entire documentation string, you can often make it much more |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
498 readable by choosing certain line breaks with care. Use blank lines |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
499 between topics if the documentation string is long. |
6552 | 500 |
501 @item | |
502 @strong{Do not} indent subsequent lines of a documentation string so | |
503 that the text is lined up in the source code with the text of the first | |
504 line. This looks nice in the source code, but looks bizarre when users | |
505 view the documentation. Remember that the indentation before the | |
506 starting double-quote is not part of the string! | |
507 | |
508 @item | |
16671
9fa09185bca0
Explain how disabled commands' doc strings are displayed.
Richard M. Stallman <rms@gnu.org>
parents:
15198
diff
changeset
|
509 When the user tries to use a disabled command, Emacs displays just the |
9fa09185bca0
Explain how disabled commands' doc strings are displayed.
Richard M. Stallman <rms@gnu.org>
parents:
15198
diff
changeset
|
510 first paragraph of its documentation string---everything through the |
9fa09185bca0
Explain how disabled commands' doc strings are displayed.
Richard M. Stallman <rms@gnu.org>
parents:
15198
diff
changeset
|
511 first blank line. If you wish, you can choose which information to |
9fa09185bca0
Explain how disabled commands' doc strings are displayed.
Richard M. Stallman <rms@gnu.org>
parents:
15198
diff
changeset
|
512 include before the first blank line so as to make this display useful. |
9fa09185bca0
Explain how disabled commands' doc strings are displayed.
Richard M. Stallman <rms@gnu.org>
parents:
15198
diff
changeset
|
513 |
9fa09185bca0
Explain how disabled commands' doc strings are displayed.
Richard M. Stallman <rms@gnu.org>
parents:
15198
diff
changeset
|
514 @item |
6552 | 515 A variable's documentation string should start with @samp{*} if the |
6959
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
516 variable is one that users would often want to set interactively. If |
7601
c5927c75b2b5
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6959
diff
changeset
|
517 the value is a long list, or a function, or if the variable would be set |
c5927c75b2b5
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6959
diff
changeset
|
518 only in init files, then don't start the documentation string with |
6552 | 519 @samp{*}. @xref{Defining Variables}. |
520 | |
521 @item | |
522 The documentation string for a variable that is a yes-or-no flag should | |
6959
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
523 start with words such as ``Non-nil means@dots{}'', to make it clear that |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
524 all non-@code{nil} values are equivalent and indicate explicitly what |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
525 @code{nil} and non-@code{nil} mean. |
6552 | 526 |
527 @item | |
528 When a function's documentation string mentions the value of an argument | |
529 of the function, use the argument name in capital letters as if it were | |
530 a name for that value. Thus, the documentation string of the function | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
531 @code{eval} refers to its second argument as @samp{FORM}, because the |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
532 actual argument name is @code{form}: |
6552 | 533 |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
534 @example |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
535 Evaluate FORM and return its value. |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
536 @end example |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
537 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
538 Also write metasyntactic variables in capital letters, such as when you |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
539 show the decomposition of a list or vector into subunits, some of which |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
540 may vary. @samp{KEY} and @samp{VALUE} in the following example |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
541 illustrate this practice: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
542 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
543 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
544 The argument TABLE should be an alist whose elements |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
545 have the form (KEY . VALUE). Here, KEY is ... |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
546 @end example |
6552 | 547 |
548 @item | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
549 If a line in a documentation string begins with an open-parenthesis, |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
550 write a backslash before the open-parenthesis, like this: |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
551 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
552 @example |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
553 The argument FOO can be either a number |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
554 \(a buffer position) or a string (a file name). |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
555 @end example |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
556 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
557 This prevents the open-parenthesis from being treated as the start of a |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
558 defun (@pxref{Defuns,, Defuns, emacs, The GNU Emacs Manual}). |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
559 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
560 @item |
6552 | 561 @iftex |
562 When a documentation string refers to a Lisp symbol, write it as it | |
563 would be printed (which usually means in lower case), with single-quotes | |
564 around it. For example: @samp{`lambda'}. There are two exceptions: | |
565 write @code{t} and @code{nil} without single-quotes. | |
566 @end iftex | |
27193 | 567 @ifnottex |
6552 | 568 When a documentation string refers to a Lisp symbol, write it as it |
569 would be printed (which usually means in lower case), with single-quotes | |
570 around it. For example: @samp{lambda}. There are two exceptions: write | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
571 t and nil without single-quotes. (In this manual, we use a different |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
572 convention, with single-quotes for all symbols.) |
27193 | 573 @end ifnottex |
6552 | 574 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
575 Help mode automatically creates a hyperlink when a documentation string |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
576 uses a symbol name inside single quotes, if the symbol has either a |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
577 function or a variable definition. You do not need to do anything |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
578 special to make use of this feature. However, when a symbol has both a |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
579 function definition and a variable definition, and you want to refer to |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
580 just one of them, you can specify which one by writing one of the words |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
581 @samp{variable}, @samp{option}, @samp{function}, or @samp{command}, |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
582 immediately before the symbol name. (Case makes no difference in |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
583 recognizing these indicator words.) For example, if you write |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
584 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
585 @example |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
586 This function sets the variable `buffer-file-name'. |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
587 @end example |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
588 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
589 @noindent |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
590 then the hyperlink will refer only to the variable documentation of |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
591 @code{buffer-file-name}, and not to its function documentation. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
592 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
593 If a symbol has a function definition and/or a variable definition, but |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
594 those are irrelevant to the use of the symbol that you are documenting, |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
595 you can write the word @samp{symbol} before the symbol name to prevent |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
596 making any hyperlink. For example, |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
597 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
598 @example |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
599 If the argument KIND-OF-RESULT is the symbol `list', |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
600 this function returns a list of all the objects |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
601 that satisfy the criterion. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
602 @end example |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
603 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
604 @noindent |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
605 does not make a hyperlink to the documentation, irrelevant here, of the |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
606 function @code{list}. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
607 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
608 To make a hyperlink to Info documentation, write the name of the Info |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
609 node in single quotes, preceded by @samp{info node} or @samp{Info |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
610 node}. The Info file name defaults to @samp{emacs}. For example, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
611 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
612 @smallexample |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
613 See Info node `Font Lock' and Info node `(elisp)Font Lock Basics'. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
614 @end smallexample |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
615 |
6552 | 616 @item |
617 Don't write key sequences directly in documentation strings. Instead, | |
618 use the @samp{\\[@dots{}]} construct to stand for them. For example, | |
16736
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
16671
diff
changeset
|
619 instead of writing @samp{C-f}, write the construct |
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
16671
diff
changeset
|
620 @samp{\\[forward-char]}. When Emacs displays the documentation string, |
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
16671
diff
changeset
|
621 it substitutes whatever key is currently bound to @code{forward-char}. |
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
16671
diff
changeset
|
622 (This is normally @samp{C-f}, but it may be some other character if the |
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
16671
diff
changeset
|
623 user has moved key bindings.) @xref{Keys in Documentation}. |
6552 | 624 |
625 @item | |
626 In documentation strings for a major mode, you will want to refer to the | |
627 key bindings of that mode's local map, rather than global ones. | |
628 Therefore, use the construct @samp{\\<@dots{}>} once in the | |
629 documentation string to specify which key map to use. Do this before | |
630 the first use of @samp{\\[@dots{}]}. The text inside the | |
631 @samp{\\<@dots{}>} should be the name of the variable containing the | |
632 local keymap for the major mode. | |
633 | |
634 It is not practical to use @samp{\\[@dots{}]} very many times, because | |
635 display of the documentation string will become slow. So use this to | |
636 describe the most important commands in your major mode, and then use | |
637 @samp{\\@{@dots{}@}} to display the rest of the mode's keymap. | |
638 @end itemize | |
639 | |
640 @node Comment Tips | |
641 @section Tips on Writing Comments | |
642 | |
643 We recommend these conventions for where to put comments and how to | |
644 indent them: | |
645 | |
646 @table @samp | |
647 @item ; | |
648 Comments that start with a single semicolon, @samp{;}, should all be | |
649 aligned to the same column on the right of the source code. Such | |
650 comments usually explain how the code on the same line does its job. In | |
651 Lisp mode and related modes, the @kbd{M-;} (@code{indent-for-comment}) | |
652 command automatically inserts such a @samp{;} in the right place, or | |
6959
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
653 aligns such a comment if it is already present. |
6552 | 654 |
7601
c5927c75b2b5
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6959
diff
changeset
|
655 This and following examples are taken from the Emacs sources. |
6552 | 656 |
657 @smallexample | |
658 @group | |
659 (setq base-version-list ; there was a base | |
660 (assoc (substring fn 0 start-vn) ; version to which | |
661 file-version-assoc-list)) ; this looks like | |
662 ; a subversion | |
663 @end group | |
664 @end smallexample | |
665 | |
666 @item ;; | |
667 Comments that start with two semicolons, @samp{;;}, should be aligned to | |
6959
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
668 the same level of indentation as the code. Such comments usually |
6552 | 669 describe the purpose of the following lines or the state of the program |
670 at that point. For example: | |
671 | |
672 @smallexample | |
673 @group | |
674 (prog1 (setq auto-fill-function | |
675 @dots{} | |
676 @dots{} | |
6959
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
677 ;; update mode line |
6552 | 678 (force-mode-line-update))) |
679 @end group | |
680 @end smallexample | |
681 | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
682 We also normally use two semicolons for comments outside functions. |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
683 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
684 @smallexample |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
685 @group |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
686 ;; This Lisp code is run in Emacs |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
687 ;; when it is to operate as a server |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
688 ;; for other processes. |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
689 @end group |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
690 @end smallexample |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
691 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
692 Every function that has no documentation string (presumably one that is |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
693 used only internally within the package it belongs to), should instead |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
694 have a two-semicolon comment right before the function, explaining what |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
695 the function does and how to call it properly. Explain precisely what |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
696 each argument means and how the function interprets its possible values. |
6552 | 697 |
698 @item ;;; | |
699 Comments that start with three semicolons, @samp{;;;}, should start at | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
700 the left margin. These are used, occasionally, for comments within |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
701 functions that should start at the margin. We also use them sometimes |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
702 for comments that are between functions---whether to use two or three |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
703 semicolons there is a matter of style. |
6552 | 704 |
7601
c5927c75b2b5
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6959
diff
changeset
|
705 Another use for triple-semicolon comments is for commenting out lines |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
706 within a function. We use three semicolons for this precisely so that |
6959
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
707 they remain at the left margin. |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
708 |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
709 @smallexample |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
710 (defun foo (a) |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
711 ;;; This is no longer necessary. |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
712 ;;; (force-mode-line-update) |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
713 (message "Finished with %s" a)) |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
714 @end smallexample |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
715 |
6552 | 716 @item ;;;; |
717 Comments that start with four semicolons, @samp{;;;;}, should be aligned | |
718 to the left margin and are used for headings of major sections of a | |
719 program. For example: | |
720 | |
721 @smallexample | |
722 ;;;; The kill ring | |
723 @end smallexample | |
724 @end table | |
725 | |
726 @noindent | |
727 The indentation commands of the Lisp modes in Emacs, such as @kbd{M-;} | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
728 (@code{indent-for-comment}) and @key{TAB} (@code{lisp-indent-line}), |
6552 | 729 automatically indent comments according to these conventions, |
7601
c5927c75b2b5
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6959
diff
changeset
|
730 depending on the number of semicolons. @xref{Comments,, |
6552 | 731 Manipulating Comments, emacs, The GNU Emacs Manual}. |
732 | |
733 @node Library Headers | |
734 @section Conventional Headers for Emacs Libraries | |
735 @cindex header comments | |
736 @cindex library header comments | |
737 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
738 Emacs has conventions for using special comments in Lisp libraries |
6552 | 739 to divide them into sections and give information such as who wrote |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
740 them. This section explains these conventions. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
741 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
742 We'll start with an example, a package that is included in the Emacs |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
743 distribution. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
744 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
745 Parts of this example reflect its status as part of Emacs; for |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
746 example, the copyright notice lists the Free Software Foundation as the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
747 copyright holder, and the copying permission says the file is part of |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
748 Emacs. When you write a package and post it, the copyright holder would |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
749 be you (unless your employer claims to own it instead), and you should |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
750 get the suggested copying permission from the end of the GNU General |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
751 Public License itself. Don't say your file is part of Emacs |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
752 if we haven't installed it in Emacs yet! |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
753 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
754 With that warning out of the way, on to the example: |
6552 | 755 |
756 @smallexample | |
757 @group | |
758 ;;; lisp-mnt.el --- minor mode for Emacs Lisp maintainers | |
759 | |
760 ;; Copyright (C) 1992 Free Software Foundation, Inc. | |
761 @end group | |
762 | |
763 ;; Author: Eric S. Raymond <esr@@snark.thyrsus.com> | |
764 ;; Maintainer: Eric S. Raymond <esr@@snark.thyrsus.com> | |
765 ;; Created: 14 Jul 1992 | |
766 ;; Version: 1.2 | |
767 @group | |
768 ;; Keywords: docs | |
769 | |
770 ;; This file is part of GNU Emacs. | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
771 @dots{} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
772 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
773 ;; Boston, MA 02111-1307, USA. |
6552 | 774 @end group |
775 @end smallexample | |
776 | |
777 The very first line should have this format: | |
778 | |
779 @example | |
780 ;;; @var{filename} --- @var{description} | |
781 @end example | |
782 | |
783 @noindent | |
784 The description should be complete in one line. | |
785 | |
786 After the copyright notice come several @dfn{header comment} lines, | |
6959
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
787 each beginning with @samp{;; @var{header-name}:}. Here is a table of |
6552 | 788 the conventional possibilities for @var{header-name}: |
789 | |
790 @table @samp | |
791 @item Author | |
792 This line states the name and net address of at least the principal | |
793 author of the library. | |
794 | |
795 If there are multiple authors, you can list them on continuation lines | |
6959
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
796 led by @code{;;} and a tab character, like this: |
6552 | 797 |
798 @smallexample | |
799 @group | |
800 ;; Author: Ashwin Ram <Ram-Ashwin@@cs.yale.edu> | |
6959
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
801 ;; Dave Sill <de5@@ornl.gov> |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
802 ;; Dave Brennan <brennan@@hal.com> |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
803 ;; Eric Raymond <esr@@snark.thyrsus.com> |
6552 | 804 @end group |
805 @end smallexample | |
806 | |
807 @item Maintainer | |
808 This line should contain a single name/address as in the Author line, or | |
6959
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
809 an address only, or the string @samp{FSF}. If there is no maintainer |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
810 line, the person(s) in the Author field are presumed to be the |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
811 maintainers. The example above is mildly bogus because the maintainer |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
812 line is redundant. |
6552 | 813 |
814 The idea behind the @samp{Author} and @samp{Maintainer} lines is to make | |
815 possible a Lisp function to ``send mail to the maintainer'' without | |
816 having to mine the name out by hand. | |
817 | |
818 Be sure to surround the network address with @samp{<@dots{}>} if | |
819 you include the person's full name as well as the network address. | |
820 | |
821 @item Created | |
822 This optional line gives the original creation date of the | |
823 file. For historical interest only. | |
824 | |
825 @item Version | |
826 If you wish to record version numbers for the individual Lisp program, put | |
827 them in this line. | |
828 | |
829 @item Adapted-By | |
830 In this header line, place the name of the person who adapted the | |
831 library for installation (to make it fit the style conventions, for | |
832 example). | |
833 | |
834 @item Keywords | |
835 This line lists keywords for the @code{finder-by-keyword} help command. | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
836 Please use that command to see a list of the meaningful keywords. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
837 |
6552 | 838 This field is important; it's how people will find your package when |
10229
634f36d4b2ae
Give syntax of keywords.
Richard M. Stallman <rms@gnu.org>
parents:
10225
diff
changeset
|
839 they're looking for things by topic area. To separate the keywords, you |
634f36d4b2ae
Give syntax of keywords.
Richard M. Stallman <rms@gnu.org>
parents:
10225
diff
changeset
|
840 can use spaces, commas, or both. |
6552 | 841 @end table |
842 | |
843 Just about every Lisp library ought to have the @samp{Author} and | |
844 @samp{Keywords} header comment lines. Use the others if they are | |
845 appropriate. You can also put in header lines with other header | |
846 names---they have no standard meanings, so they can't do any harm. | |
847 | |
848 We use additional stylized comments to subdivide the contents of the | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
849 library file. These should be separated by blank lines from anything |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
850 else. Here is a table of them: |
6552 | 851 |
852 @table @samp | |
853 @item ;;; Commentary: | |
854 This begins introductory comments that explain how the library works. | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
855 It should come right after the copying permissions, terminated by a |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
856 @samp{Change Log}, @samp{History} or @samp{Code} comment line. This |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
857 text is used by the Finder package, so it should make sense in that |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
858 context. |
6552 | 859 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
860 @item ;;; Documentation |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
861 This has been used in some files in place of @samp{;;; Commentary:}, |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
862 but @samp{;;; Commentary:} is preferred. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
863 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
864 @item ;;; Change Log: |
6552 | 865 This begins change log information stored in the library file (if you |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
866 store the change history there). For Lisp files distributed with Emacs, |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
867 the change history is kept in the file @file{ChangeLog} and not in the |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
868 source file at all; these files generally do not have a @samp{;;; Change |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
869 Log:} line. @samp{History} is an alternative to @samp{Change Log}. |
6552 | 870 |
871 @item ;;; Code: | |
872 This begins the actual code of the program. | |
873 | |
874 @item ;;; @var{filename} ends here | |
875 This is the @dfn{footer line}; it appears at the very end of the file. | |
876 Its purpose is to enable people to detect truncated versions of the file | |
877 from the lack of a footer line. | |
878 @end table |