Mercurial > emacs
annotate lispref/tips.texi @ 17083:9e6a3e03ed4c
Initial revision
author | Kenichi Handa <handa@m17n.org> |
---|---|
date | Wed, 26 Feb 1997 12:22:56 +0000 |
parents | 981e116b4ac6 |
children | 96762d1abb7c |
rev | line source |
---|---|
6552 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
3 @c Copyright (C) 1990, 1991, 1992, 1993 Free Software Foundation, Inc. | |
4 @c See the file elisp.texi for copying conditions. | |
5 @setfilename ../info/tips | |
6 @node Tips, GNU Emacs Internals, Calendar, Top | |
7 @appendix Tips and Standards | |
8 @cindex tips | |
9 @cindex standards of coding style | |
10 @cindex coding standards | |
11 | |
12 This chapter describes no additional features of Emacs Lisp. | |
13 Instead it gives advice on making effective use of the features described | |
14 in the previous chapters. | |
15 | |
16 @menu | |
17 * Style Tips:: Writing clean and robust programs. | |
18 * Compilation Tips:: Making compiled code run fast. | |
19 * Documentation Tips:: Writing readable documentation strings. | |
20 * Comment Tips:: Conventions for writing comments. | |
21 * Library Headers:: Standard headers for library packages. | |
22 @end menu | |
23 | |
24 @node Style Tips | |
25 @section Writing Clean Lisp Programs | |
26 | |
27 Here are some tips for avoiding common errors in writing Lisp code | |
28 intended for widespread use: | |
29 | |
30 @itemize @bullet | |
31 @item | |
32 Since all global variables share the same name space, and all functions | |
33 share another name space, you should choose a short word to distinguish | |
34 your program from other Lisp programs. Then take care to begin the | |
35 names of all global variables, constants, and functions with the chosen | |
36 prefix. This helps avoid name conflicts. | |
37 | |
38 This recommendation applies even to names for traditional Lisp | |
39 primitives that are not primitives in Emacs Lisp---even to @code{cadr}. | |
40 Believe it or not, there is more than one plausible way to define | |
41 @code{cadr}. Play it safe; append your name prefix to produce a name | |
42 like @code{foo-cadr} or @code{mylib-cadr} instead. | |
43 | |
44 If you write a function that you think ought to be added to Emacs under | |
45 a certain name, such as @code{twiddle-files}, don't call it by that name | |
46 in your program. Call it @code{mylib-twiddle-files} in your program, | |
47 and send mail to @samp{bug-gnu-emacs@@prep.ai.mit.edu} suggesting we add | |
48 it to Emacs. If and when we do, we can change the name easily enough. | |
49 | |
50 If one prefix is insufficient, your package may use two or three | |
51 alternative common prefixes, so long as they make sense. | |
52 | |
53 Separate the prefix from the rest of the symbol name with a hyphen, | |
54 @samp{-}. This will be consistent with Emacs itself and with most Emacs | |
55 Lisp programs. | |
56 | |
57 @item | |
58 It is often useful to put a call to @code{provide} in each separate | |
59 library program, at least if there is more than one entry point to the | |
60 program. | |
61 | |
62 @item | |
12098 | 63 If a file requires certain other library programs to be loaded |
64 beforehand, then the comments at the beginning of the file should say | |
65 so. Also, use @code{require} to make sure they are loaded. | |
66 | |
67 @item | |
6552 | 68 If one file @var{foo} uses a macro defined in another file @var{bar}, |
12098 | 69 @var{foo} should contain this expression before the first use of the |
70 macro: | |
71 | |
72 @example | |
73 (eval-when-compile (require '@var{bar})) | |
74 @end example | |
75 | |
76 @noindent | |
77 (And @var{bar} should contain @code{(provide '@var{bar})}, to make the | |
78 @code{require} work.) This will cause @var{bar} to be loaded when you | |
79 byte-compile @var{foo}. Otherwise, you risk compiling @var{foo} without | |
80 the necessary macro loaded, and that would produce compiled code that | |
81 won't work right. @xref{Compiling Macros}. | |
82 | |
83 Using @code{eval-when-compile} avoids loading @var{bar} when | |
84 the compiled version of @var{foo} is @emph{used}. | |
6552 | 85 |
86 @item | |
87 If you define a major mode, make sure to run a hook variable using | |
88 @code{run-hooks}, just as the existing major modes do. @xref{Hooks}. | |
89 | |
90 @item | |
9807
d5fa87d62d62
Add function and variable name conventions.
Richard M. Stallman <rms@gnu.org>
parents:
9393
diff
changeset
|
91 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
|
92 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
|
93 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
|
94 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
|
95 |
d5fa87d62d62
Add function and variable name conventions.
Richard M. Stallman <rms@gnu.org>
parents:
9393
diff
changeset
|
96 @item |
d5fa87d62d62
Add function and variable name conventions.
Richard M. Stallman <rms@gnu.org>
parents:
9393
diff
changeset
|
97 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
|
98 name that ends in @samp{-flag}. |
d5fa87d62d62
Add function and variable name conventions.
Richard M. Stallman <rms@gnu.org>
parents:
9393
diff
changeset
|
99 |
d5fa87d62d62
Add function and variable name conventions.
Richard M. Stallman <rms@gnu.org>
parents:
9393
diff
changeset
|
100 @item |
6552 | 101 Please do not define @kbd{C-c @var{letter}} as a key in your major |
102 modes. These sequences are reserved for users; they are the | |
103 @strong{only} sequences reserved for users, so we cannot do without | |
104 them. | |
105 | |
14394
289506921917
Clarify key sequence usage conventions.
Richard M. Stallman <rms@gnu.org>
parents:
14028
diff
changeset
|
106 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
|
107 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
|
108 are reserved for major modes. |
6552 | 109 |
110 Changing all the major modes in Emacs 18 so they would follow this | |
11648
e09e51d7c35a
Describe uses of C-c followed by punctuation chars.
Richard M. Stallman <rms@gnu.org>
parents:
10229
diff
changeset
|
111 convention was a lot of work. Abandoning this convention would make |
e09e51d7c35a
Describe uses of C-c followed by punctuation chars.
Richard M. Stallman <rms@gnu.org>
parents:
10229
diff
changeset
|
112 that work go to waste, and inconvenience users. |
e09e51d7c35a
Describe uses of C-c followed by punctuation chars.
Richard M. Stallman <rms@gnu.org>
parents:
10229
diff
changeset
|
113 |
e09e51d7c35a
Describe uses of C-c followed by punctuation chars.
Richard M. Stallman <rms@gnu.org>
parents:
10229
diff
changeset
|
114 @item |
e09e51d7c35a
Describe uses of C-c followed by punctuation chars.
Richard M. Stallman <rms@gnu.org>
parents:
10229
diff
changeset
|
115 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
|
116 @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
|
117 |
e09e51d7c35a
Describe uses of C-c followed by punctuation chars.
Richard M. Stallman <rms@gnu.org>
parents:
10229
diff
changeset
|
118 @item |
e09e51d7c35a
Describe uses of C-c followed by punctuation chars.
Richard M. Stallman <rms@gnu.org>
parents:
10229
diff
changeset
|
119 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
|
120 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
|
121 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
|
122 may be shadowed from time to time by minor modes. |
6552 | 123 |
124 @item | |
125 You should not bind @kbd{C-h} following any prefix character (including | |
126 @kbd{C-c}). If you don't bind @kbd{C-h}, it is automatically available | |
127 as a help character for listing the subcommands of the prefix character. | |
128 | |
129 @item | |
130 You should not bind a key sequence ending in @key{ESC} except following | |
131 another @key{ESC}. (That is, it is ok to bind a sequence ending in | |
132 @kbd{@key{ESC} @key{ESC}}.) | |
133 | |
134 The reason for this rule is that a non-prefix binding for @key{ESC} in | |
135 any context prevents recognition of escape sequences as function keys in | |
136 that context. | |
137 | |
138 @item | |
6959
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
139 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
|
140 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
|
141 @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
|
142 users. |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
143 |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
144 @item |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
145 Modes should redefine @kbd{mouse-2} as a command to follow some sort of |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
146 reference in the text of a buffer, if users usually would not want to |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
147 alter the text in that buffer by hand. Modes such as Dired, Info, |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
148 Compilation, and Occur redefine it in this way. |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
149 |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
150 @item |
9393
0bec3b6bac2f
Add a tip about enabling/disabling features.
Richard M. Stallman <rms@gnu.org>
parents:
8669
diff
changeset
|
151 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
|
152 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
|
153 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
|
154 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
|
155 that simply loading it has no visible effect---that should not enable |
0bec3b6bac2f
Add a tip about enabling/disabling features.
Richard M. Stallman <rms@gnu.org>
parents:
8669
diff
changeset
|
156 the feature. Users will request the feature by invoking the command. |
0bec3b6bac2f
Add a tip about enabling/disabling features.
Richard M. Stallman <rms@gnu.org>
parents:
8669
diff
changeset
|
157 |
0bec3b6bac2f
Add a tip about enabling/disabling features.
Richard M. Stallman <rms@gnu.org>
parents:
8669
diff
changeset
|
158 @item |
0bec3b6bac2f
Add a tip about enabling/disabling features.
Richard M. Stallman <rms@gnu.org>
parents:
8669
diff
changeset
|
159 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
|
160 standard names instead. |
6552 | 161 |
162 @item | |
163 Redefining an Emacs primitive is an even worse idea. | |
164 It may do the right thing for a particular program, but | |
165 there is no telling what other programs might break as a result. | |
166 | |
167 @item | |
168 If a file does replace any of the functions or library programs of | |
169 standard Emacs, prominent comments at the beginning of the file should | |
170 say which functions are replaced, and how the behavior of the | |
171 replacements differs from that of the originals. | |
172 | |
173 @item | |
174 Please keep the names of your Emacs Lisp source files to 13 characters | |
175 or less. This way, if the files are compiled, the compiled files' names | |
176 will be 14 characters or less, which is short enough to fit on all kinds | |
177 of Unix systems. | |
178 | |
179 @item | |
180 Don't use @code{next-line} or @code{previous-line} in programs; nearly | |
181 always, @code{forward-line} is more convenient as well as more | |
182 predictable and robust. @xref{Text Lines}. | |
183 | |
184 @item | |
7601
c5927c75b2b5
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6959
diff
changeset
|
185 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
|
186 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
|
187 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
|
188 for the user's benefit. @xref{The Mark}. |
6552 | 189 |
190 In particular, don't use these functions: | |
191 | |
192 @itemize @bullet | |
193 @item | |
194 @code{beginning-of-buffer}, @code{end-of-buffer} | |
195 @item | |
196 @code{replace-string}, @code{replace-regexp} | |
197 @end itemize | |
198 | |
199 If you just want to move point, or replace a certain string, without any | |
200 of the other features intended for interactive users, you can replace | |
201 these functions with one or two lines of simple Lisp code. | |
202 | |
203 @item | |
8669 | 204 Use lists rather than vectors, except when there is a particular reason |
205 to use a vector. Lisp has more facilities for manipulating lists than | |
206 for vectors, and working with lists is usually more convenient. | |
207 | |
208 Vectors are advantageous for tables that are substantial in size and are | |
209 accessed in random order (not searched front to back), provided there is | |
210 no need to insert or delete elements (only lists allow that). | |
211 | |
212 @item | |
6552 | 213 The recommended way to print a message in the echo area is with |
214 the @code{message} function, not @code{princ}. @xref{The Echo Area}. | |
215 | |
216 @item | |
217 When you encounter an error condition, call the function @code{error} | |
218 (or @code{signal}). The function @code{error} does not return. | |
219 @xref{Signaling Errors}. | |
220 | |
221 Do not use @code{message}, @code{throw}, @code{sleep-for}, | |
222 or @code{beep} to report errors. | |
223 | |
224 @item | |
12098 | 225 An error message should start with a capital letter but should not end |
226 with a period. | |
227 | |
228 @item | |
13893
2576d1142ed3
Explain style of "done" messages.
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
229 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
|
230 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
|
231 @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
|
232 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
|
233 @emph{no} period at the end. |
2576d1142ed3
Explain style of "done" messages.
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
234 |
2576d1142ed3
Explain style of "done" messages.
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
235 @item |
6959
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
236 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
|
237 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
|
238 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
|
239 @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
|
240 user switch back at will. @xref{Recursive Editing}. |
6552 | 241 |
242 @item | |
243 In some other systems there is a convention of choosing variable names | |
244 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
|
245 Lisp, so please don't use it in your programs. (Emacs uses such names |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
246 only for program-generated buffers.) The users will find Emacs more |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
247 coherent if all libraries use the same conventions. |
6552 | 248 |
249 @item | |
14028
e8d6c760f796
Explain eliminating compiler warnings about undefined variables.
Richard M. Stallman <rms@gnu.org>
parents:
13893
diff
changeset
|
250 Try to avoid compiler warnings about undefined free variables, by adding |
15198 | 251 @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
|
252 |
e8d6c760f796
Explain eliminating compiler warnings about undefined variables.
Richard M. Stallman <rms@gnu.org>
parents:
13893
diff
changeset
|
253 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
|
254 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
|
255 variable has a definition. But often these variables have short names, |
e8d6c760f796
Explain eliminating compiler warnings about undefined variables.
Richard M. Stallman <rms@gnu.org>
parents:
13893
diff
changeset
|
256 and it is not clean for Lisp packages to define such variables names. |
e8d6c760f796
Explain eliminating compiler warnings about undefined variables.
Richard M. Stallman <rms@gnu.org>
parents:
13893
diff
changeset
|
257 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
|
258 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
|
259 |
e8d6c760f796
Explain eliminating compiler warnings about undefined variables.
Richard M. Stallman <rms@gnu.org>
parents:
13893
diff
changeset
|
260 @item |
6552 | 261 Indent each function with @kbd{C-M-q} (@code{indent-sexp}) using the |
262 default indentation parameters. | |
263 | |
264 @item | |
265 Don't make a habit of putting close-parentheses on lines by themselves; | |
266 Lisp programmers find this disconcerting. Once in a while, when there | |
267 is a sequence of many consecutive close-parentheses, it may make sense | |
268 to split them in one or two significant places. | |
269 | |
270 @item | |
271 Please put a copyright notice on the file if you give copies to anyone. | |
272 Use the same lines that appear at the top of the Lisp files in Emacs | |
273 itself. If you have not signed papers to assign the copyright to the | |
274 Foundation, then place your name in the copyright notice in place of the | |
275 Foundation's name. | |
276 @end itemize | |
277 | |
278 @node Compilation Tips | |
279 @section Tips for Making Compiled Code Fast | |
280 @cindex execution speed | |
281 @cindex speedups | |
282 | |
283 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
|
284 Lisp programs. |
6552 | 285 |
286 @itemize @bullet | |
287 @item | |
288 @cindex profiling | |
289 @cindex timing programs | |
290 @cindex @file{profile.el} | |
291 Use the @file{profile} library to profile your program. See the file | |
292 @file{profile.el} for instructions. | |
293 | |
294 @item | |
295 Use iteration rather than recursion whenever possible. | |
296 Function calls are slow in Emacs Lisp even when a compiled function | |
297 is calling another compiled function. | |
298 | |
299 @item | |
12098 | 300 Using the primitive list-searching functions @code{memq}, @code{member}, |
301 @code{assq}, or @code{assoc} is even faster than explicit iteration. It | |
302 may be worth rearranging a data structure so that one of these primitive | |
303 search functions can be used. | |
6552 | 304 |
305 @item | |
6959
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
306 Certain built-in functions are handled specially in byte-compiled code, |
6552 | 307 avoiding the need for an ordinary function call. It is a good idea to |
308 use these functions rather than alternatives. To see whether a function | |
309 is handled specially by the compiler, examine its @code{byte-compile} | |
310 property. If the property is non-@code{nil}, then the function is | |
311 handled specially. | |
312 | |
313 For example, the following input will show you that @code{aref} is | |
314 compiled specially (@pxref{Array Functions}) while @code{elt} is not | |
315 (@pxref{Sequence Functions}): | |
316 | |
6959
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
317 @example |
6552 | 318 @group |
319 (get 'aref 'byte-compile) | |
320 @result{} byte-compile-two-args | |
321 @end group | |
322 | |
323 @group | |
324 (get 'elt 'byte-compile) | |
325 @result{} nil | |
326 @end group | |
6959
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
327 @end example |
6552 | 328 |
329 @item | |
330 If calling a small function accounts for a substantial part of your | |
331 program's running time, make the function inline. This eliminates | |
332 the function call overhead. Since making a function inline reduces | |
333 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
|
334 a noticeable speedup in something slow enough that users care about |
6552 | 335 the speed. @xref{Inline Functions}. |
336 @end itemize | |
337 | |
338 @node Documentation Tips | |
339 @section Tips for Documentation Strings | |
340 | |
341 Here are some tips for the writing of documentation strings. | |
342 | |
343 @itemize @bullet | |
344 @item | |
7601
c5927c75b2b5
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6959
diff
changeset
|
345 Every command, function, or variable intended for users to know about |
6552 | 346 should have a documentation string. |
347 | |
348 @item | |
10225
2e5dcd5f3090
Recommend doc strings for all functions and variables.
Richard M. Stallman <rms@gnu.org>
parents:
9807
diff
changeset
|
349 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
|
350 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
|
351 by using a comment instead of a documentation string, but that is no |
2e5dcd5f3090
Recommend doc strings for all functions and variables.
Richard M. Stallman <rms@gnu.org>
parents:
9807
diff
changeset
|
352 longer the case. |
6552 | 353 |
354 @item | |
355 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
|
356 complete sentences that stand on their own as a summary. @kbd{M-x |
6959
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
357 apropos} displays just the first line, and if it doesn't stand on its |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
358 own, the result looks bad. In particular, start the first line with a |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
359 capital letter and end with a period. |
6552 | 360 |
7601
c5927c75b2b5
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6959
diff
changeset
|
361 The documentation string can have additional lines that expand on the |
6552 | 362 details of how to use the function or variable. The additional lines |
363 should be made up of complete sentences also, but they may be filled if | |
364 that looks good. | |
365 | |
366 @item | |
6959
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
367 For consistency, phrase the verb in the first sentence of a |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
368 documentation string as an infinitive with ``to'' omitted. For |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
369 instance, use ``Return the cons of A and B.'' in preference to ``Returns |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
370 the cons of A and B@.'' Usually it looks good to do likewise for the |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
371 rest of the first paragraph. Subsequent paragraphs usually look better |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
372 if they have proper subjects. |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
373 |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
374 @item |
6552 | 375 Write documentation strings in the active voice, not the passive, and in |
376 the present tense, not the future. For instance, use ``Return a list | |
377 containing A and B.'' instead of ``A list containing A and B will be | |
378 returned.'' | |
379 | |
380 @item | |
381 Avoid using the word ``cause'' (or its equivalents) unnecessarily. | |
382 Instead of, ``Cause Emacs to display text in boldface,'' write just | |
383 ``Display text in boldface.'' | |
384 | |
385 @item | |
386 Do not start or end a documentation string with whitespace. | |
387 | |
388 @item | |
389 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
|
390 80-column screen. It is a good idea for most lines to be no wider than |
6552 | 391 60 characters. The first line can be wider if necessary to fit the |
392 information that ought to be there. | |
393 | |
394 However, rather than simply filling the entire documentation string, you | |
395 can make it much more readable by choosing line breaks with care. | |
396 Use blank lines between topics if the documentation string is long. | |
397 | |
398 @item | |
399 @strong{Do not} indent subsequent lines of a documentation string so | |
400 that the text is lined up in the source code with the text of the first | |
401 line. This looks nice in the source code, but looks bizarre when users | |
402 view the documentation. Remember that the indentation before the | |
403 starting double-quote is not part of the string! | |
404 | |
405 @item | |
16671
9fa09185bca0
Explain how disabled commands' doc strings are displayed.
Richard M. Stallman <rms@gnu.org>
parents:
15198
diff
changeset
|
406 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
|
407 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
|
408 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
|
409 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
|
410 |
9fa09185bca0
Explain how disabled commands' doc strings are displayed.
Richard M. Stallman <rms@gnu.org>
parents:
15198
diff
changeset
|
411 @item |
6552 | 412 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
|
413 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
|
414 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
|
415 only in init files, then don't start the documentation string with |
6552 | 416 @samp{*}. @xref{Defining Variables}. |
417 | |
418 @item | |
419 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
|
420 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
|
421 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
|
422 @code{nil} and non-@code{nil} mean. |
6552 | 423 |
424 @item | |
425 When a function's documentation string mentions the value of an argument | |
426 of the function, use the argument name in capital letters as if it were | |
427 a name for that value. Thus, the documentation string of the function | |
6959
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
428 @code{/} refers to its second argument as @samp{DIVISOR}, because the |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
429 actual argument name is @code{divisor}. |
6552 | 430 |
431 Also use all caps for meta-syntactic variables, such as when you show | |
432 the decomposition of a list or vector into subunits, some of which may | |
433 vary. | |
434 | |
435 @item | |
436 @iftex | |
437 When a documentation string refers to a Lisp symbol, write it as it | |
438 would be printed (which usually means in lower case), with single-quotes | |
439 around it. For example: @samp{`lambda'}. There are two exceptions: | |
440 write @code{t} and @code{nil} without single-quotes. | |
441 @end iftex | |
442 @ifinfo | |
443 When a documentation string refers to a Lisp symbol, write it as it | |
444 would be printed (which usually means in lower case), with single-quotes | |
445 around it. For example: @samp{lambda}. There are two exceptions: write | |
446 t and nil without single-quotes. (In this manual, we normally do use | |
447 single-quotes for those symbols.) | |
448 @end ifinfo | |
449 | |
450 @item | |
451 Don't write key sequences directly in documentation strings. Instead, | |
452 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
|
453 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
|
454 @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
|
455 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
|
456 (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
|
457 user has moved key bindings.) @xref{Keys in Documentation}. |
6552 | 458 |
459 @item | |
460 In documentation strings for a major mode, you will want to refer to the | |
461 key bindings of that mode's local map, rather than global ones. | |
462 Therefore, use the construct @samp{\\<@dots{}>} once in the | |
463 documentation string to specify which key map to use. Do this before | |
464 the first use of @samp{\\[@dots{}]}. The text inside the | |
465 @samp{\\<@dots{}>} should be the name of the variable containing the | |
466 local keymap for the major mode. | |
467 | |
468 It is not practical to use @samp{\\[@dots{}]} very many times, because | |
469 display of the documentation string will become slow. So use this to | |
470 describe the most important commands in your major mode, and then use | |
471 @samp{\\@{@dots{}@}} to display the rest of the mode's keymap. | |
472 @end itemize | |
473 | |
474 @node Comment Tips | |
475 @section Tips on Writing Comments | |
476 | |
477 We recommend these conventions for where to put comments and how to | |
478 indent them: | |
479 | |
480 @table @samp | |
481 @item ; | |
482 Comments that start with a single semicolon, @samp{;}, should all be | |
483 aligned to the same column on the right of the source code. Such | |
484 comments usually explain how the code on the same line does its job. In | |
485 Lisp mode and related modes, the @kbd{M-;} (@code{indent-for-comment}) | |
486 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
|
487 aligns such a comment if it is already present. |
6552 | 488 |
7601
c5927c75b2b5
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6959
diff
changeset
|
489 This and following examples are taken from the Emacs sources. |
6552 | 490 |
491 @smallexample | |
492 @group | |
493 (setq base-version-list ; there was a base | |
494 (assoc (substring fn 0 start-vn) ; version to which | |
495 file-version-assoc-list)) ; this looks like | |
496 ; a subversion | |
497 @end group | |
498 @end smallexample | |
499 | |
500 @item ;; | |
501 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
|
502 the same level of indentation as the code. Such comments usually |
6552 | 503 describe the purpose of the following lines or the state of the program |
504 at that point. For example: | |
505 | |
506 @smallexample | |
507 @group | |
508 (prog1 (setq auto-fill-function | |
509 @dots{} | |
510 @dots{} | |
6959
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
511 ;; update mode line |
6552 | 512 (force-mode-line-update))) |
513 @end group | |
514 @end smallexample | |
515 | |
6959
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
516 Every function that has no documentation string (because it is use only |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
517 internally within the package it belongs to), should have instead a |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
518 two-semicolon comment right before the function, explaining what the |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
519 function does and how to call it properly. Explain precisely what each |
7601
c5927c75b2b5
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6959
diff
changeset
|
520 argument means and how the function interprets its possible values. |
6552 | 521 |
522 @item ;;; | |
523 Comments that start with three semicolons, @samp{;;;}, should start at | |
6959
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
524 the left margin. Such comments are used outside function definitions to |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
525 make general statements explaining the design principles of the program. |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
526 For example: |
6552 | 527 |
528 @smallexample | |
529 @group | |
530 ;;; This Lisp code is run in Emacs | |
531 ;;; when it is to operate as a server | |
532 ;;; for other processes. | |
533 @end group | |
534 @end smallexample | |
535 | |
7601
c5927c75b2b5
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6959
diff
changeset
|
536 Another use for triple-semicolon comments is for commenting out lines |
6959
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
537 within a function. We use triple-semicolons for this precisely so that |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
538 they remain at the left margin. |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
539 |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
540 @smallexample |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
541 (defun foo (a) |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
542 ;;; This is no longer necessary. |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
543 ;;; (force-mode-line-update) |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
544 (message "Finished with %s" a)) |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
545 @end smallexample |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
546 |
6552 | 547 @item ;;;; |
548 Comments that start with four semicolons, @samp{;;;;}, should be aligned | |
549 to the left margin and are used for headings of major sections of a | |
550 program. For example: | |
551 | |
552 @smallexample | |
553 ;;;; The kill ring | |
554 @end smallexample | |
555 @end table | |
556 | |
557 @noindent | |
558 The indentation commands of the Lisp modes in Emacs, such as @kbd{M-;} | |
559 (@code{indent-for-comment}) and @key{TAB} (@code{lisp-indent-line}) | |
560 automatically indent comments according to these conventions, | |
7601
c5927c75b2b5
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6959
diff
changeset
|
561 depending on the number of semicolons. @xref{Comments,, |
6552 | 562 Manipulating Comments, emacs, The GNU Emacs Manual}. |
563 | |
564 @node Library Headers | |
565 @section Conventional Headers for Emacs Libraries | |
566 @cindex header comments | |
567 @cindex library header comments | |
568 | |
569 Emacs 19 has conventions for using special comments in Lisp libraries | |
570 to divide them into sections and give information such as who wrote | |
571 them. This section explains these conventions. First, an example: | |
572 | |
573 @smallexample | |
574 @group | |
575 ;;; lisp-mnt.el --- minor mode for Emacs Lisp maintainers | |
576 | |
577 ;; Copyright (C) 1992 Free Software Foundation, Inc. | |
578 @end group | |
579 | |
580 ;; Author: Eric S. Raymond <esr@@snark.thyrsus.com> | |
581 ;; Maintainer: Eric S. Raymond <esr@@snark.thyrsus.com> | |
582 ;; Created: 14 Jul 1992 | |
583 ;; Version: 1.2 | |
584 @group | |
585 ;; Keywords: docs | |
586 | |
587 ;; This file is part of GNU Emacs. | |
7601
c5927c75b2b5
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6959
diff
changeset
|
588 @var{copying permissions}@dots{} |
6552 | 589 @end group |
590 @end smallexample | |
591 | |
592 The very first line should have this format: | |
593 | |
594 @example | |
595 ;;; @var{filename} --- @var{description} | |
596 @end example | |
597 | |
598 @noindent | |
599 The description should be complete in one line. | |
600 | |
601 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
|
602 each beginning with @samp{;; @var{header-name}:}. Here is a table of |
6552 | 603 the conventional possibilities for @var{header-name}: |
604 | |
605 @table @samp | |
606 @item Author | |
607 This line states the name and net address of at least the principal | |
608 author of the library. | |
609 | |
610 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
|
611 led by @code{;;} and a tab character, like this: |
6552 | 612 |
613 @smallexample | |
614 @group | |
615 ;; Author: Ashwin Ram <Ram-Ashwin@@cs.yale.edu> | |
6959
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
616 ;; Dave Sill <de5@@ornl.gov> |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
617 ;; Dave Brennan <brennan@@hal.com> |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
618 ;; Eric Raymond <esr@@snark.thyrsus.com> |
6552 | 619 @end group |
620 @end smallexample | |
621 | |
622 @item Maintainer | |
623 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
|
624 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
|
625 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
|
626 maintainers. The example above is mildly bogus because the maintainer |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
627 line is redundant. |
6552 | 628 |
629 The idea behind the @samp{Author} and @samp{Maintainer} lines is to make | |
630 possible a Lisp function to ``send mail to the maintainer'' without | |
631 having to mine the name out by hand. | |
632 | |
633 Be sure to surround the network address with @samp{<@dots{}>} if | |
634 you include the person's full name as well as the network address. | |
635 | |
636 @item Created | |
637 This optional line gives the original creation date of the | |
638 file. For historical interest only. | |
639 | |
640 @item Version | |
641 If you wish to record version numbers for the individual Lisp program, put | |
642 them in this line. | |
643 | |
644 @item Adapted-By | |
645 In this header line, place the name of the person who adapted the | |
646 library for installation (to make it fit the style conventions, for | |
647 example). | |
648 | |
649 @item Keywords | |
650 This line lists keywords for the @code{finder-by-keyword} help command. | |
651 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
|
652 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
|
653 can use spaces, commas, or both. |
6552 | 654 @end table |
655 | |
656 Just about every Lisp library ought to have the @samp{Author} and | |
657 @samp{Keywords} header comment lines. Use the others if they are | |
658 appropriate. You can also put in header lines with other header | |
659 names---they have no standard meanings, so they can't do any harm. | |
660 | |
661 We use additional stylized comments to subdivide the contents of the | |
662 library file. Here is a table of them: | |
663 | |
664 @table @samp | |
665 @item ;;; Commentary: | |
666 This begins introductory comments that explain how the library works. | |
667 It should come right after the copying permissions. | |
668 | |
669 @item ;;; Change log: | |
670 This begins change log information stored in the library file (if you | |
671 store the change history there). For most of the Lisp | |
672 files distributed with Emacs, the change history is kept in the file | |
673 @file{ChangeLog} and not in the source file at all; these files do | |
674 not have a @samp{;;; Change log:} line. | |
675 | |
676 @item ;;; Code: | |
677 This begins the actual code of the program. | |
678 | |
679 @item ;;; @var{filename} ends here | |
680 This is the @dfn{footer line}; it appears at the very end of the file. | |
681 Its purpose is to enable people to detect truncated versions of the file | |
682 from the lack of a footer line. | |
683 @end table |