Mercurial > emacs
annotate lispref/tips.texi @ 8580:648f78c8ecf5
Fixed bug in tcl-guess-application.
author | Tom Tromey <tromey@redhat.com> |
---|---|
date | Sun, 21 Aug 1994 20:33:05 +0000 |
parents | c5927c75b2b5 |
children | 62d1138d10de |
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 | |
63 If one file @var{foo} uses a macro defined in another file @var{bar}, | |
64 @var{foo} should contain @code{(require '@var{bar})} before the first | |
65 use of the macro. (And @var{bar} should contain @code{(provide | |
66 '@var{bar})}, to make the @code{require} work.) This will cause | |
67 @var{bar} to be loaded when you byte-compile @var{foo}. Otherwise, you | |
68 risk compiling @var{foo} without the necessary macro loaded, and that | |
69 would produce compiled code that won't work right. @xref{Compiling | |
70 Macros}. | |
71 | |
72 @item | |
73 If you define a major mode, make sure to run a hook variable using | |
74 @code{run-hooks}, just as the existing major modes do. @xref{Hooks}. | |
75 | |
76 @item | |
77 Please do not define @kbd{C-c @var{letter}} as a key in your major | |
78 modes. These sequences are reserved for users; they are the | |
79 @strong{only} sequences reserved for users, so we cannot do without | |
80 them. | |
81 | |
82 Instead, define sequences consisting of @kbd{C-c} followed by a | |
83 non-letter. These sequences are reserved for major modes. | |
84 | |
85 Changing all the major modes in Emacs 18 so they would follow this | |
86 convention was a lot of work. Abandoning this convention would waste | |
87 that work and inconvenience the users. | |
88 | |
89 @item | |
90 You should not bind @kbd{C-h} following any prefix character (including | |
91 @kbd{C-c}). If you don't bind @kbd{C-h}, it is automatically available | |
92 as a help character for listing the subcommands of the prefix character. | |
93 | |
94 @item | |
95 You should not bind a key sequence ending in @key{ESC} except following | |
96 another @key{ESC}. (That is, it is ok to bind a sequence ending in | |
97 @kbd{@key{ESC} @key{ESC}}.) | |
98 | |
99 The reason for this rule is that a non-prefix binding for @key{ESC} in | |
100 any context prevents recognition of escape sequences as function keys in | |
101 that context. | |
102 | |
103 @item | |
6959
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
104 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
|
105 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
|
106 @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
|
107 users. |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
108 |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
109 @item |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
110 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
|
111 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
|
112 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
|
113 Compilation, and Occur redefine it in this way. |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
114 |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
115 @item |
6552 | 116 It is a bad idea to define aliases for the Emacs primitives. |
117 Use the standard names instead. | |
118 | |
119 @item | |
120 Redefining an Emacs primitive is an even worse idea. | |
121 It may do the right thing for a particular program, but | |
122 there is no telling what other programs might break as a result. | |
123 | |
124 @item | |
125 If a file does replace any of the functions or library programs of | |
126 standard Emacs, prominent comments at the beginning of the file should | |
127 say which functions are replaced, and how the behavior of the | |
128 replacements differs from that of the originals. | |
129 | |
130 @item | |
131 If a file requires certain standard library programs to be loaded | |
132 beforehand, then the comments at the beginning of the file should say | |
133 so. | |
134 | |
135 @item | |
136 Please keep the names of your Emacs Lisp source files to 13 characters | |
137 or less. This way, if the files are compiled, the compiled files' names | |
138 will be 14 characters or less, which is short enough to fit on all kinds | |
139 of Unix systems. | |
140 | |
141 @item | |
142 Don't use @code{next-line} or @code{previous-line} in programs; nearly | |
143 always, @code{forward-line} is more convenient as well as more | |
144 predictable and robust. @xref{Text Lines}. | |
145 | |
146 @item | |
7601
c5927c75b2b5
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6959
diff
changeset
|
147 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
|
148 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
|
149 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
|
150 for the user's benefit. @xref{The Mark}. |
6552 | 151 |
152 In particular, don't use these functions: | |
153 | |
154 @itemize @bullet | |
155 @item | |
156 @code{beginning-of-buffer}, @code{end-of-buffer} | |
157 @item | |
158 @code{replace-string}, @code{replace-regexp} | |
159 @end itemize | |
160 | |
161 If you just want to move point, or replace a certain string, without any | |
162 of the other features intended for interactive users, you can replace | |
163 these functions with one or two lines of simple Lisp code. | |
164 | |
165 @item | |
166 The recommended way to print a message in the echo area is with | |
167 the @code{message} function, not @code{princ}. @xref{The Echo Area}. | |
168 | |
169 @item | |
170 When you encounter an error condition, call the function @code{error} | |
171 (or @code{signal}). The function @code{error} does not return. | |
172 @xref{Signaling Errors}. | |
173 | |
174 Do not use @code{message}, @code{throw}, @code{sleep-for}, | |
175 or @code{beep} to report errors. | |
176 | |
177 @item | |
6959
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
178 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
|
179 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
|
180 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
|
181 @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
|
182 user switch back at will. @xref{Recursive Editing}. |
6552 | 183 |
184 @item | |
185 In some other systems there is a convention of choosing variable names | |
186 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
|
187 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
|
188 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
|
189 coherent if all libraries use the same conventions. |
6552 | 190 |
191 @item | |
192 Indent each function with @kbd{C-M-q} (@code{indent-sexp}) using the | |
193 default indentation parameters. | |
194 | |
195 @item | |
196 Don't make a habit of putting close-parentheses on lines by themselves; | |
197 Lisp programmers find this disconcerting. Once in a while, when there | |
198 is a sequence of many consecutive close-parentheses, it may make sense | |
199 to split them in one or two significant places. | |
200 | |
201 @item | |
202 Please put a copyright notice on the file if you give copies to anyone. | |
203 Use the same lines that appear at the top of the Lisp files in Emacs | |
204 itself. If you have not signed papers to assign the copyright to the | |
205 Foundation, then place your name in the copyright notice in place of the | |
206 Foundation's name. | |
207 @end itemize | |
208 | |
209 @node Compilation Tips | |
210 @section Tips for Making Compiled Code Fast | |
211 @cindex execution speed | |
212 @cindex speedups | |
213 | |
214 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
|
215 Lisp programs. |
6552 | 216 |
217 @itemize @bullet | |
218 @item | |
219 @cindex profiling | |
220 @cindex timing programs | |
221 @cindex @file{profile.el} | |
222 Use the @file{profile} library to profile your program. See the file | |
223 @file{profile.el} for instructions. | |
224 | |
225 @item | |
226 Use iteration rather than recursion whenever possible. | |
227 Function calls are slow in Emacs Lisp even when a compiled function | |
228 is calling another compiled function. | |
229 | |
230 @item | |
7601
c5927c75b2b5
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6959
diff
changeset
|
231 Using the primitive list-searching functions @code{memq}, @code{assq}, or |
6552 | 232 @code{assoc} is even faster than explicit iteration. It may be worth |
233 rearranging a data structure so that one of these primitive search | |
234 functions can be used. | |
235 | |
236 @item | |
6959
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
237 Certain built-in functions are handled specially in byte-compiled code, |
6552 | 238 avoiding the need for an ordinary function call. It is a good idea to |
239 use these functions rather than alternatives. To see whether a function | |
240 is handled specially by the compiler, examine its @code{byte-compile} | |
241 property. If the property is non-@code{nil}, then the function is | |
242 handled specially. | |
243 | |
244 For example, the following input will show you that @code{aref} is | |
245 compiled specially (@pxref{Array Functions}) while @code{elt} is not | |
246 (@pxref{Sequence Functions}): | |
247 | |
6959
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
248 @example |
6552 | 249 @group |
250 (get 'aref 'byte-compile) | |
251 @result{} byte-compile-two-args | |
252 @end group | |
253 | |
254 @group | |
255 (get 'elt 'byte-compile) | |
256 @result{} nil | |
257 @end group | |
6959
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
258 @end example |
6552 | 259 |
260 @item | |
261 If calling a small function accounts for a substantial part of your | |
262 program's running time, make the function inline. This eliminates | |
263 the function call overhead. Since making a function inline reduces | |
264 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
|
265 a noticeable speedup in something slow enough that users care about |
6552 | 266 the speed. @xref{Inline Functions}. |
267 @end itemize | |
268 | |
269 @node Documentation Tips | |
270 @section Tips for Documentation Strings | |
271 | |
272 Here are some tips for the writing of documentation strings. | |
273 | |
274 @itemize @bullet | |
275 @item | |
7601
c5927c75b2b5
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6959
diff
changeset
|
276 Every command, function, or variable intended for users to know about |
6552 | 277 should have a documentation string. |
278 | |
279 @item | |
280 An internal subroutine of a Lisp program need not have a documentation | |
281 string, and you can save space by using a comment instead. | |
282 | |
283 @item | |
284 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
|
285 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
|
286 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
|
287 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
|
288 capital letter and end with a period. |
6552 | 289 |
7601
c5927c75b2b5
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6959
diff
changeset
|
290 The documentation string can have additional lines that expand on the |
6552 | 291 details of how to use the function or variable. The additional lines |
292 should be made up of complete sentences also, but they may be filled if | |
293 that looks good. | |
294 | |
295 @item | |
6959
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
296 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
|
297 documentation string as an infinitive with ``to'' omitted. For |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
298 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
|
299 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
|
300 rest of the first paragraph. Subsequent paragraphs usually look better |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
301 if they have proper subjects. |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
302 |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
303 @item |
6552 | 304 Write documentation strings in the active voice, not the passive, and in |
305 the present tense, not the future. For instance, use ``Return a list | |
306 containing A and B.'' instead of ``A list containing A and B will be | |
307 returned.'' | |
308 | |
309 @item | |
310 Avoid using the word ``cause'' (or its equivalents) unnecessarily. | |
311 Instead of, ``Cause Emacs to display text in boldface,'' write just | |
312 ``Display text in boldface.'' | |
313 | |
314 @item | |
315 Do not start or end a documentation string with whitespace. | |
316 | |
317 @item | |
318 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
|
319 80-column screen. It is a good idea for most lines to be no wider than |
6552 | 320 60 characters. The first line can be wider if necessary to fit the |
321 information that ought to be there. | |
322 | |
323 However, rather than simply filling the entire documentation string, you | |
324 can make it much more readable by choosing line breaks with care. | |
325 Use blank lines between topics if the documentation string is long. | |
326 | |
327 @item | |
328 @strong{Do not} indent subsequent lines of a documentation string so | |
329 that the text is lined up in the source code with the text of the first | |
330 line. This looks nice in the source code, but looks bizarre when users | |
331 view the documentation. Remember that the indentation before the | |
332 starting double-quote is not part of the string! | |
333 | |
334 @item | |
335 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
|
336 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
|
337 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
|
338 only in init files, then don't start the documentation string with |
6552 | 339 @samp{*}. @xref{Defining Variables}. |
340 | |
341 @item | |
342 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
|
343 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
|
344 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
|
345 @code{nil} and non-@code{nil} mean. |
6552 | 346 |
347 @item | |
348 When a function's documentation string mentions the value of an argument | |
349 of the function, use the argument name in capital letters as if it were | |
350 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
|
351 @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
|
352 actual argument name is @code{divisor}. |
6552 | 353 |
354 Also use all caps for meta-syntactic variables, such as when you show | |
355 the decomposition of a list or vector into subunits, some of which may | |
356 vary. | |
357 | |
358 @item | |
359 @iftex | |
360 When a documentation string refers to a Lisp symbol, write it as it | |
361 would be printed (which usually means in lower case), with single-quotes | |
362 around it. For example: @samp{`lambda'}. There are two exceptions: | |
363 write @code{t} and @code{nil} without single-quotes. | |
364 @end iftex | |
365 @ifinfo | |
366 When a documentation string refers to a Lisp symbol, write it as it | |
367 would be printed (which usually means in lower case), with single-quotes | |
368 around it. For example: @samp{lambda}. There are two exceptions: write | |
369 t and nil without single-quotes. (In this manual, we normally do use | |
370 single-quotes for those symbols.) | |
371 @end ifinfo | |
372 | |
373 @item | |
374 Don't write key sequences directly in documentation strings. Instead, | |
375 use the @samp{\\[@dots{}]} construct to stand for them. For example, | |
6959
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
376 instead of writing @samp{C-f}, write @samp{\\[forward-char]}. When |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
377 Emacs displays the documentation string, it substitutes whatever key is |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
378 currently bound to @code{forward-char}. (This is normally @samp{C-f}, |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
379 but it may be some other character if the user has moved key bindings.) |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
380 @xref{Keys in Documentation}. |
6552 | 381 |
382 @item | |
383 In documentation strings for a major mode, you will want to refer to the | |
384 key bindings of that mode's local map, rather than global ones. | |
385 Therefore, use the construct @samp{\\<@dots{}>} once in the | |
386 documentation string to specify which key map to use. Do this before | |
387 the first use of @samp{\\[@dots{}]}. The text inside the | |
388 @samp{\\<@dots{}>} should be the name of the variable containing the | |
389 local keymap for the major mode. | |
390 | |
391 It is not practical to use @samp{\\[@dots{}]} very many times, because | |
392 display of the documentation string will become slow. So use this to | |
393 describe the most important commands in your major mode, and then use | |
394 @samp{\\@{@dots{}@}} to display the rest of the mode's keymap. | |
395 | |
396 @item | |
397 Don't use the term ``Elisp'', since that is or was a trademark. | |
398 Use the term ``Emacs Lisp''. | |
399 @end itemize | |
400 | |
401 @node Comment Tips | |
402 @section Tips on Writing Comments | |
403 | |
404 We recommend these conventions for where to put comments and how to | |
405 indent them: | |
406 | |
407 @table @samp | |
408 @item ; | |
409 Comments that start with a single semicolon, @samp{;}, should all be | |
410 aligned to the same column on the right of the source code. Such | |
411 comments usually explain how the code on the same line does its job. In | |
412 Lisp mode and related modes, the @kbd{M-;} (@code{indent-for-comment}) | |
413 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
|
414 aligns such a comment if it is already present. |
6552 | 415 |
7601
c5927c75b2b5
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6959
diff
changeset
|
416 This and following examples are taken from the Emacs sources. |
6552 | 417 |
418 @smallexample | |
419 @group | |
420 (setq base-version-list ; there was a base | |
421 (assoc (substring fn 0 start-vn) ; version to which | |
422 file-version-assoc-list)) ; this looks like | |
423 ; a subversion | |
424 @end group | |
425 @end smallexample | |
426 | |
427 @item ;; | |
428 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
|
429 the same level of indentation as the code. Such comments usually |
6552 | 430 describe the purpose of the following lines or the state of the program |
431 at that point. For example: | |
432 | |
433 @smallexample | |
434 @group | |
435 (prog1 (setq auto-fill-function | |
436 @dots{} | |
437 @dots{} | |
6959
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
438 ;; update mode line |
6552 | 439 (force-mode-line-update))) |
440 @end group | |
441 @end smallexample | |
442 | |
6959
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
443 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
|
444 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
|
445 two-semicolon comment right before the function, explaining what the |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
446 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
|
447 argument means and how the function interprets its possible values. |
6552 | 448 |
449 @item ;;; | |
450 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
|
451 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
|
452 make general statements explaining the design principles of the program. |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
453 For example: |
6552 | 454 |
455 @smallexample | |
456 @group | |
457 ;;; This Lisp code is run in Emacs | |
458 ;;; when it is to operate as a server | |
459 ;;; for other processes. | |
460 @end group | |
461 @end smallexample | |
462 | |
7601
c5927c75b2b5
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6959
diff
changeset
|
463 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
|
464 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
|
465 they remain at the left margin. |
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 @smallexample |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
468 (defun foo (a) |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
469 ;;; This is no longer necessary. |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
470 ;;; (force-mode-line-update) |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
471 (message "Finished with %s" a)) |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
472 @end smallexample |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
473 |
6552 | 474 @item ;;;; |
475 Comments that start with four semicolons, @samp{;;;;}, should be aligned | |
476 to the left margin and are used for headings of major sections of a | |
477 program. For example: | |
478 | |
479 @smallexample | |
480 ;;;; The kill ring | |
481 @end smallexample | |
482 @end table | |
483 | |
484 @noindent | |
485 The indentation commands of the Lisp modes in Emacs, such as @kbd{M-;} | |
486 (@code{indent-for-comment}) and @key{TAB} (@code{lisp-indent-line}) | |
487 automatically indent comments according to these conventions, | |
7601
c5927c75b2b5
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6959
diff
changeset
|
488 depending on the number of semicolons. @xref{Comments,, |
6552 | 489 Manipulating Comments, emacs, The GNU Emacs Manual}. |
490 | |
491 @node Library Headers | |
492 @section Conventional Headers for Emacs Libraries | |
493 @cindex header comments | |
494 @cindex library header comments | |
495 | |
496 Emacs 19 has conventions for using special comments in Lisp libraries | |
497 to divide them into sections and give information such as who wrote | |
498 them. This section explains these conventions. First, an example: | |
499 | |
500 @smallexample | |
501 @group | |
502 ;;; lisp-mnt.el --- minor mode for Emacs Lisp maintainers | |
503 | |
504 ;; Copyright (C) 1992 Free Software Foundation, Inc. | |
505 @end group | |
506 | |
507 ;; Author: Eric S. Raymond <esr@@snark.thyrsus.com> | |
508 ;; Maintainer: Eric S. Raymond <esr@@snark.thyrsus.com> | |
509 ;; Created: 14 Jul 1992 | |
510 ;; Version: 1.2 | |
511 @group | |
512 ;; Keywords: docs | |
513 | |
514 ;; This file is part of GNU Emacs. | |
7601
c5927c75b2b5
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6959
diff
changeset
|
515 @var{copying permissions}@dots{} |
6552 | 516 @end group |
517 @end smallexample | |
518 | |
519 The very first line should have this format: | |
520 | |
521 @example | |
522 ;;; @var{filename} --- @var{description} | |
523 @end example | |
524 | |
525 @noindent | |
526 The description should be complete in one line. | |
527 | |
528 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
|
529 each beginning with @samp{;; @var{header-name}:}. Here is a table of |
6552 | 530 the conventional possibilities for @var{header-name}: |
531 | |
532 @table @samp | |
533 @item Author | |
534 This line states the name and net address of at least the principal | |
535 author of the library. | |
536 | |
537 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
|
538 led by @code{;;} and a tab character, like this: |
6552 | 539 |
540 @smallexample | |
541 @group | |
542 ;; Author: Ashwin Ram <Ram-Ashwin@@cs.yale.edu> | |
6959
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
543 ;; Dave Sill <de5@@ornl.gov> |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
544 ;; Dave Brennan <brennan@@hal.com> |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
545 ;; Eric Raymond <esr@@snark.thyrsus.com> |
6552 | 546 @end group |
547 @end smallexample | |
548 | |
549 @item Maintainer | |
550 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
|
551 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
|
552 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
|
553 maintainers. The example above is mildly bogus because the maintainer |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
554 line is redundant. |
6552 | 555 |
556 The idea behind the @samp{Author} and @samp{Maintainer} lines is to make | |
557 possible a Lisp function to ``send mail to the maintainer'' without | |
558 having to mine the name out by hand. | |
559 | |
560 Be sure to surround the network address with @samp{<@dots{}>} if | |
561 you include the person's full name as well as the network address. | |
562 | |
563 @item Created | |
564 This optional line gives the original creation date of the | |
565 file. For historical interest only. | |
566 | |
567 @item Version | |
568 If you wish to record version numbers for the individual Lisp program, put | |
569 them in this line. | |
570 | |
571 @item Adapted-By | |
572 In this header line, place the name of the person who adapted the | |
573 library for installation (to make it fit the style conventions, for | |
574 example). | |
575 | |
576 @item Keywords | |
577 This line lists keywords for the @code{finder-by-keyword} help command. | |
578 This field is important; it's how people will find your package when | |
579 they're looking for things by topic area. | |
580 @end table | |
581 | |
582 Just about every Lisp library ought to have the @samp{Author} and | |
583 @samp{Keywords} header comment lines. Use the others if they are | |
584 appropriate. You can also put in header lines with other header | |
585 names---they have no standard meanings, so they can't do any harm. | |
586 | |
587 We use additional stylized comments to subdivide the contents of the | |
588 library file. Here is a table of them: | |
589 | |
590 @table @samp | |
591 @item ;;; Commentary: | |
592 This begins introductory comments that explain how the library works. | |
593 It should come right after the copying permissions. | |
594 | |
595 @item ;;; Change log: | |
596 This begins change log information stored in the library file (if you | |
597 store the change history there). For most of the Lisp | |
598 files distributed with Emacs, the change history is kept in the file | |
599 @file{ChangeLog} and not in the source file at all; these files do | |
600 not have a @samp{;;; Change log:} line. | |
601 | |
602 @item ;;; Code: | |
603 This begins the actual code of the program. | |
604 | |
605 @item ;;; @var{filename} ends here | |
606 This is the @dfn{footer line}; it appears at the very end of the file. | |
607 Its purpose is to enable people to detect truncated versions of the file | |
608 from the lack of a footer line. | |
609 @end table |