Mercurial > emacs
annotate doc/lispref/tips.texi @ 94788:8d78530778f5
Switch to recommended form of GPLv3 permissions notice.
author | Glenn Morris <rgm@gnu.org> |
---|---|
date | Fri, 09 May 2008 04:38:00 +0000 |
parents | 107ccd98fa12 |
children | fde6f792a832 |
rev | line source |
---|---|
84105 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1995, 1998, 1999, 2001, 2002, | |
87649 | 4 @c 2003, 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc. |
84105 | 5 @c See the file elisp.texi for copying conditions. |
84116
0ba80d073e27
(setfilename): Go up one more level to ../../info.
Glenn Morris <rgm@gnu.org>
parents:
84105
diff
changeset
|
6 @setfilename ../../info/tips |
84105 | 7 @node Tips, GNU Emacs Internals, GPL, Top |
8 @appendix Tips and Conventions | |
9 @cindex tips for writing Lisp | |
10 @cindex standards of coding style | |
11 @cindex coding standards | |
12 | |
13 This chapter describes no additional features of Emacs Lisp. Instead | |
14 it gives advice on making effective use of the features described in the | |
15 previous chapters, and describes conventions Emacs Lisp programmers | |
16 should follow. | |
17 | |
18 You can automatically check some of the conventions described below by | |
19 running the command @kbd{M-x checkdoc RET} when visiting a Lisp file. | |
20 It cannot check all of the conventions, and not all the warnings it | |
21 gives necessarily correspond to problems, but it is worth examining them | |
22 all. | |
23 | |
24 @menu | |
25 * Coding Conventions:: Conventions for clean and robust programs. | |
26 * Key Binding Conventions:: Which keys should be bound by which programs. | |
27 * Programming Tips:: Making Emacs code fit smoothly in Emacs. | |
28 * Compilation Tips:: Making compiled code run fast. | |
29 * Warning Tips:: Turning off compiler warnings. | |
30 * Documentation Tips:: Writing readable documentation strings. | |
31 * Comment Tips:: Conventions for writing comments. | |
32 * Library Headers:: Standard headers for library packages. | |
33 @end menu | |
34 | |
35 @node Coding Conventions | |
36 @section Emacs Lisp Coding Conventions | |
37 | |
38 @cindex coding conventions in Emacs Lisp | |
39 Here are conventions that you should follow when writing Emacs Lisp | |
40 code intended for widespread use: | |
41 | |
42 @itemize @bullet | |
43 @item | |
44 Simply loading the package should not change Emacs's editing behavior. | |
45 Include a command or commands to enable and disable the feature, | |
46 or to invoke it. | |
47 | |
48 This convention is mandatory for any file that includes custom | |
49 definitions. If fixing such a file to follow this convention requires | |
50 an incompatible change, go ahead and make the incompatible change; | |
51 don't postpone it. | |
52 | |
53 @item | |
54 Since all global variables share the same name space, and all | |
55 functions share another name space, you should choose a short word to | |
56 distinguish your program from other Lisp programs@footnote{The | |
57 benefits of a Common Lisp-style package system are considered not to | |
58 outweigh the costs.}. Then take care to begin the names of all global | |
59 variables, constants, and functions in your program with the chosen | |
60 prefix. This helps avoid name conflicts. | |
61 | |
62 Occasionally, for a command name intended for users to use, it is more | |
63 convenient if some words come before the package's name prefix. And | |
64 constructs that define functions, variables, etc., work better if they | |
65 start with @samp{defun} or @samp{defvar}, so put the name prefix later | |
66 on in the name. | |
67 | |
68 This recommendation applies even to names for traditional Lisp | |
69 primitives that are not primitives in Emacs Lisp---such as | |
70 @code{copy-list}. Believe it or not, there is more than one plausible | |
71 way to define @code{copy-list}. Play it safe; append your name prefix | |
72 to produce a name like @code{foo-copy-list} or @code{mylib-copy-list} | |
73 instead. | |
74 | |
75 If you write a function that you think ought to be added to Emacs under | |
76 a certain name, such as @code{twiddle-files}, don't call it by that name | |
77 in your program. Call it @code{mylib-twiddle-files} in your program, | |
78 and send mail to @samp{bug-gnu-emacs@@gnu.org} suggesting we add | |
79 it to Emacs. If and when we do, we can change the name easily enough. | |
80 | |
81 If one prefix is insufficient, your package can use two or three | |
82 alternative common prefixes, so long as they make sense. | |
83 | |
84 Separate the prefix from the rest of the symbol name with a hyphen, | |
85 @samp{-}. This will be consistent with Emacs itself and with most Emacs | |
86 Lisp programs. | |
87 | |
88 @item | |
89 Put a call to @code{provide} at the end of each separate Lisp file. | |
90 | |
91 @item | |
92 If a file requires certain other Lisp programs to be loaded | |
93 beforehand, then the comments at the beginning of the file should say | |
94 so. Also, use @code{require} to make sure they are loaded. | |
95 | |
96 @item | |
97 If one file @var{foo} uses a macro defined in another file @var{bar}, | |
98 @var{foo} should contain this expression before the first use of the | |
99 macro: | |
100 | |
101 @example | |
102 (eval-when-compile (require '@var{bar})) | |
103 @end example | |
104 | |
105 @noindent | |
106 (And the library @var{bar} should contain @code{(provide '@var{bar})}, | |
107 to make the @code{require} work.) This will cause @var{bar} to be | |
108 loaded when you byte-compile @var{foo}. Otherwise, you risk compiling | |
109 @var{foo} without the necessary macro loaded, and that would produce | |
110 compiled code that won't work right. @xref{Compiling Macros}. | |
111 | |
112 Using @code{eval-when-compile} avoids loading @var{bar} when | |
113 the compiled version of @var{foo} is @emph{used}. | |
114 | |
115 @item | |
116 Please don't require the @code{cl} package of Common Lisp extensions at | |
117 run time. Use of this package is optional, and it is not part of the | |
118 standard Emacs namespace. If your package loads @code{cl} at run time, | |
119 that could cause name clashes for users who don't use that package. | |
120 | |
121 However, there is no problem with using the @code{cl} package at | |
122 compile time, with @code{(eval-when-compile (require 'cl))}. That's | |
123 sufficient for using the macros in the @code{cl} package, because the | |
124 compiler expands them before generating the byte-code. | |
125 | |
126 @item | |
127 When defining a major mode, please follow the major mode | |
128 conventions. @xref{Major Mode Conventions}. | |
129 | |
130 @item | |
131 When defining a minor mode, please follow the minor mode | |
132 conventions. @xref{Minor Mode Conventions}. | |
133 | |
134 @item | |
135 If the purpose of a function is to tell you whether a certain condition | |
136 is true or false, give the function a name that ends in @samp{p}. If | |
137 the name is one word, add just @samp{p}; if the name is multiple words, | |
138 add @samp{-p}. Examples are @code{framep} and @code{frame-live-p}. | |
139 | |
140 @item | |
141 If a user option variable records a true-or-false condition, give it a | |
142 name that ends in @samp{-flag}. | |
143 | |
144 @item | |
145 If the purpose of a variable is to store a single function, give it a | |
146 name that ends in @samp{-function}. If the purpose of a variable is | |
147 to store a list of functions (i.e., the variable is a hook), please | |
148 follow the naming conventions for hooks. @xref{Hooks}. | |
149 | |
150 @item | |
151 @cindex unloading packages, preparing for | |
152 If loading the file adds functions to hooks, define a function | |
153 @code{@var{feature}-unload-hook}, where @var{feature} is the name of | |
154 the feature the package provides, and make it undo any such changes. | |
155 Using @code{unload-feature} to unload the file will run this function. | |
156 @xref{Unloading}. | |
157 | |
158 @item | |
159 It is a bad idea to define aliases for the Emacs primitives. Normally | |
160 you should use the standard names instead. The case where an alias | |
161 may be useful is where it facilitates backwards compatibility or | |
162 portability. | |
163 | |
164 @item | |
165 If a package needs to define an alias or a new function for | |
166 compatibility with some other version of Emacs, name it with the package | |
167 prefix, not with the raw name with which it occurs in the other version. | |
168 Here is an example from Gnus, which provides many examples of such | |
169 compatibility issues. | |
170 | |
171 @example | |
172 (defalias 'gnus-point-at-bol | |
173 (if (fboundp 'point-at-bol) | |
174 'point-at-bol | |
175 'line-beginning-position)) | |
176 @end example | |
177 | |
178 @item | |
179 Redefining (or advising) an Emacs primitive is a bad idea. It may do | |
180 the right thing for a particular program, but there is no telling what | |
181 other programs might break as a result. In any case, it is a problem | |
182 for debugging, because the advised function doesn't do what its source | |
183 code says it does. If the programmer investigating the problem is | |
184 unaware that there is advice on the function, the experience can be | |
185 very frustrating. | |
186 | |
187 We hope to remove all the places in Emacs that advise primitives. | |
188 In the mean time, please don't add any more. | |
189 | |
190 @item | |
191 It is likewise a bad idea for one Lisp package to advise a function | |
192 in another Lisp package. | |
193 | |
194 @item | |
195 Likewise, avoid using @code{eval-after-load} (@pxref{Hooks for | |
196 Loading}) in libraries and packages. This feature is meant for | |
197 personal customizations; using it in a Lisp program is unclean, | |
198 because it modifies the behavior of another Lisp file in a way that's | |
199 not visible in that file. This is an obstacle for debugging, much | |
200 like advising a function in the other package. | |
201 | |
202 @item | |
203 If a file does replace any of the functions or library programs of | |
204 standard Emacs, prominent comments at the beginning of the file should | |
205 say which functions are replaced, and how the behavior of the | |
206 replacements differs from that of the originals. | |
207 | |
208 @item | |
209 Constructs that define a function or variable should be macros, | |
210 not functions, and their names should start with @samp{def}. | |
211 | |
212 @item | |
213 A macro that defines a function or variable should have a name that | |
214 starts with @samp{define-}. The macro should receive the name to be | |
215 defined as the first argument. That will help various tools find the | |
216 definition automatically. Avoid constructing the names in the macro | |
217 itself, since that would confuse these tools. | |
218 | |
219 @item | |
220 Please keep the names of your Emacs Lisp source files to 13 characters | |
221 or less. This way, if the files are compiled, the compiled files' names | |
222 will be 14 characters or less, which is short enough to fit on all kinds | |
223 of Unix systems. | |
224 | |
225 @item | |
226 In some other systems there is a convention of choosing variable names | |
227 that begin and end with @samp{*}. We don't use that convention in Emacs | |
228 Lisp, so please don't use it in your programs. (Emacs uses such names | |
229 only for special-purpose buffers.) The users will find Emacs more | |
230 coherent if all libraries use the same conventions. | |
231 | |
232 @item | |
233 If your program contains non-ASCII characters in string or character | |
234 constants, you should make sure Emacs always decodes these characters | |
235 the same way, regardless of the user's settings. There are two ways | |
236 to do that: | |
237 | |
238 @itemize - | |
239 @item | |
240 Use coding system @code{emacs-mule}, and specify that for | |
241 @code{coding} in the @samp{-*-} line or the local variables list. | |
242 | |
243 @example | |
244 ;; XXX.el -*- coding: emacs-mule; -*- | |
245 @end example | |
246 | |
247 @item | |
248 Use one of the coding systems based on ISO 2022 (such as | |
249 iso-8859-@var{n} and iso-2022-7bit), and specify it with @samp{!} at | |
250 the end for @code{coding}. (The @samp{!} turns off any possible | |
251 character translation.) | |
252 | |
253 @example | |
254 ;; XXX.el -*- coding: iso-latin-2!; -*- | |
255 @end example | |
256 @end itemize | |
257 | |
258 @item | |
259 Indent each function with @kbd{C-M-q} (@code{indent-sexp}) using the | |
260 default indentation parameters. | |
261 | |
262 @item | |
263 Don't make a habit of putting close-parentheses on lines by themselves; | |
264 Lisp programmers find this disconcerting. Once in a while, when there | |
265 is a sequence of many consecutive close-parentheses, it may make sense | |
266 to split the sequence in one or two significant places. | |
267 | |
268 @item | |
269 Please put a copyright notice and copying permission notice on the | |
270 file if you distribute copies. Use a notice like this one: | |
271 | |
272 @smallexample | |
273 ;; Copyright (C) @var{year} @var{name} | |
274 | |
275 ;; This program is free software; you can redistribute it and/or | |
276 ;; modify it under the terms of the GNU General Public License as | |
277 ;; published by the Free Software Foundation; either version 3 of | |
278 ;; the License, or (at your option) any later version. | |
279 | |
280 ;; This program is distributed in the hope that it will be | |
281 ;; useful, but WITHOUT ANY WARRANTY; without even the implied | |
282 ;; warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR | |
283 ;; PURPOSE. See the GNU General Public License for more details. | |
284 | |
285 ;; You should have received a copy of the GNU General Public | |
286 ;; License along with this program; if not, write to the Free | |
287 ;; Software Foundation, Inc., 51 Franklin Street, Fifth Floor, | |
288 ;; Boston, MA 02110-1301 USA | |
289 @end smallexample | |
290 | |
291 If you have signed papers to assign the copyright to the Foundation, | |
292 then use @samp{Free Software Foundation, Inc.} as @var{name}. | |
293 Otherwise, use your name. See also @xref{Library Headers}. | |
294 @end itemize | |
295 | |
296 @node Key Binding Conventions | |
297 @section Key Binding Conventions | |
298 @cindex key binding, conventions for | |
299 | |
300 @itemize @bullet | |
301 @item | |
302 @cindex mouse-2 | |
303 @cindex references, following | |
304 Special major modes used for read-only text should usually redefine | |
305 @kbd{mouse-2} and @key{RET} to trace some sort of reference in the text. | |
306 Modes such as Dired, Info, Compilation, and Occur redefine it in this | |
307 way. | |
308 | |
309 In addition, they should mark the text as a kind of ``link'' so that | |
310 @kbd{mouse-1} will follow it also. @xref{Links and Mouse-1}. | |
311 | |
312 @item | |
313 @cindex reserved keys | |
314 @cindex keys, reserved | |
315 Please do not define @kbd{C-c @var{letter}} as a key in Lisp programs. | |
316 Sequences consisting of @kbd{C-c} and a letter (either upper or lower | |
317 case) are reserved for users; they are the @strong{only} sequences | |
318 reserved for users, so do not block them. | |
319 | |
320 Changing all the Emacs major modes to respect this convention was a | |
321 lot of work; abandoning this convention would make that work go to | |
322 waste, and inconvenience users. Please comply with it. | |
323 | |
324 @item | |
325 Function keys @key{F5} through @key{F9} without modifier keys are | |
326 also reserved for users to define. | |
327 | |
328 @item | |
329 Applications should not bind mouse events based on button 1 with the | |
330 shift key held down. These events include @kbd{S-mouse-1}, | |
331 @kbd{M-S-mouse-1}, @kbd{C-S-mouse-1}, and so on. They are reserved for | |
332 users. | |
333 | |
334 @item | |
335 Sequences consisting of @kbd{C-c} followed by a control character or a | |
336 digit are reserved for major modes. | |
337 | |
338 @item | |
339 Sequences consisting of @kbd{C-c} followed by @kbd{@{}, @kbd{@}}, | |
340 @kbd{<}, @kbd{>}, @kbd{:} or @kbd{;} are also reserved for major modes. | |
341 | |
342 @item | |
343 Sequences consisting of @kbd{C-c} followed by any other punctuation | |
344 character are allocated for minor modes. Using them in a major mode is | |
345 not absolutely prohibited, but if you do that, the major mode binding | |
346 may be shadowed from time to time by minor modes. | |
347 | |
348 @item | |
349 Do not bind @kbd{C-h} following any prefix character (including | |
350 @kbd{C-c}). If you don't bind @kbd{C-h}, it is automatically available | |
351 as a help character for listing the subcommands of the prefix character. | |
352 | |
353 @item | |
354 Do not bind a key sequence ending in @key{ESC} except following | |
355 another @key{ESC}. (That is, it is OK to bind a sequence ending in | |
356 @kbd{@key{ESC} @key{ESC}}.) | |
357 | |
358 The reason for this rule is that a non-prefix binding for @key{ESC} in | |
359 any context prevents recognition of escape sequences as function keys in | |
360 that context. | |
361 | |
362 @item | |
363 Anything which acts like a temporary mode or state which the user can | |
364 enter and leave should define @kbd{@key{ESC} @key{ESC}} or | |
365 @kbd{@key{ESC} @key{ESC} @key{ESC}} as a way to escape. | |
366 | |
367 For a state which accepts ordinary Emacs commands, or more generally any | |
368 kind of state in which @key{ESC} followed by a function key or arrow key | |
369 is potentially meaningful, then you must not define @kbd{@key{ESC} | |
370 @key{ESC}}, since that would preclude recognizing an escape sequence | |
371 after @key{ESC}. In these states, you should define @kbd{@key{ESC} | |
372 @key{ESC} @key{ESC}} as the way to escape. Otherwise, define | |
373 @kbd{@key{ESC} @key{ESC}} instead. | |
374 @end itemize | |
375 | |
376 @node Programming Tips | |
377 @section Emacs Programming Tips | |
378 @cindex programming conventions | |
379 | |
380 Following these conventions will make your program fit better | |
381 into Emacs when it runs. | |
382 | |
383 @itemize @bullet | |
384 @item | |
385 Don't use @code{next-line} or @code{previous-line} in programs; nearly | |
386 always, @code{forward-line} is more convenient as well as more | |
387 predictable and robust. @xref{Text Lines}. | |
388 | |
389 @item | |
390 Don't call functions that set the mark, unless setting the mark is one | |
391 of the intended features of your program. The mark is a user-level | |
392 feature, so it is incorrect to change the mark except to supply a value | |
393 for the user's benefit. @xref{The Mark}. | |
394 | |
395 In particular, don't use any of these functions: | |
396 | |
397 @itemize @bullet | |
398 @item | |
399 @code{beginning-of-buffer}, @code{end-of-buffer} | |
400 @item | |
401 @code{replace-string}, @code{replace-regexp} | |
402 @item | |
403 @code{insert-file}, @code{insert-buffer} | |
404 @end itemize | |
405 | |
406 If you just want to move point, or replace a certain string, or insert | |
407 a file or buffer's contents, without any of the other features | |
408 intended for interactive users, you can replace these functions with | |
409 one or two lines of simple Lisp code. | |
410 | |
411 @item | |
412 Use lists rather than vectors, except when there is a particular reason | |
413 to use a vector. Lisp has more facilities for manipulating lists than | |
414 for vectors, and working with lists is usually more convenient. | |
415 | |
416 Vectors are advantageous for tables that are substantial in size and are | |
417 accessed in random order (not searched front to back), provided there is | |
418 no need to insert or delete elements (only lists allow that). | |
419 | |
420 @item | |
421 The recommended way to show a message in the echo area is with | |
422 the @code{message} function, not @code{princ}. @xref{The Echo Area}. | |
423 | |
424 @item | |
425 When you encounter an error condition, call the function @code{error} | |
426 (or @code{signal}). The function @code{error} does not return. | |
427 @xref{Signaling Errors}. | |
428 | |
429 Do not use @code{message}, @code{throw}, @code{sleep-for}, | |
430 or @code{beep} to report errors. | |
431 | |
432 @item | |
433 An error message should start with a capital letter but should not end | |
434 with a period. | |
435 | |
436 @item | |
437 A question asked in the minibuffer with @code{y-or-n-p} or | |
438 @code{yes-or-no-p} should start with a capital letter and end with | |
439 @samp{? }. | |
440 | |
441 @item | |
442 When you mention a default value in a minibuffer prompt, | |
443 put it and the word @samp{default} inside parentheses. | |
444 It should look like this: | |
445 | |
446 @example | |
447 Enter the answer (default 42): | |
448 @end example | |
449 | |
450 @item | |
451 In @code{interactive}, if you use a Lisp expression to produce a list | |
452 of arguments, don't try to provide the ``correct'' default values for | |
453 region or position arguments. Instead, provide @code{nil} for those | |
454 arguments if they were not specified, and have the function body | |
455 compute the default value when the argument is @code{nil}. For | |
456 instance, write this: | |
457 | |
458 @example | |
459 (defun foo (pos) | |
460 (interactive | |
461 (list (if @var{specified} @var{specified-pos}))) | |
462 (unless pos (setq pos @var{default-pos})) | |
463 ...) | |
464 @end example | |
465 | |
466 @noindent | |
467 rather than this: | |
468 | |
469 @example | |
470 (defun foo (pos) | |
471 (interactive | |
472 (list (if @var{specified} @var{specified-pos} | |
473 @var{default-pos}))) | |
474 ...) | |
475 @end example | |
476 | |
477 @noindent | |
478 This is so that repetition of the command will recompute | |
479 these defaults based on the current circumstances. | |
480 | |
481 You do not need to take such precautions when you use interactive | |
482 specs @samp{d}, @samp{m} and @samp{r}, because they make special | |
483 arrangements to recompute the argument values on repetition of the | |
484 command. | |
485 | |
486 @item | |
487 Many commands that take a long time to execute display a message that | |
488 says something like @samp{Operating...} when they start, and change it to | |
489 @samp{Operating...done} when they finish. Please keep the style of | |
490 these messages uniform: @emph{no} space around the ellipsis, and | |
491 @emph{no} period after @samp{done}. | |
492 | |
493 @item | |
494 Try to avoid using recursive edits. Instead, do what the Rmail @kbd{e} | |
495 command does: use a new local keymap that contains one command defined | |
496 to switch back to the old local keymap. Or do what the | |
497 @code{edit-options} command does: switch to another buffer and let the | |
498 user switch back at will. @xref{Recursive Editing}. | |
499 @end itemize | |
500 | |
501 @node Compilation Tips | |
502 @section Tips for Making Compiled Code Fast | |
503 @cindex execution speed | |
504 @cindex speedups | |
505 | |
506 Here are ways of improving the execution speed of byte-compiled | |
507 Lisp programs. | |
508 | |
509 @itemize @bullet | |
510 @item | |
511 @cindex profiling | |
512 @cindex timing programs | |
513 @cindex @file{elp.el} | |
514 Profile your program with the @file{elp} library. See the file | |
515 @file{elp.el} for instructions. | |
516 | |
517 @item | |
518 @cindex @file{benchmark.el} | |
519 @cindex benchmarking | |
520 Check the speed of individual Emacs Lisp forms using the | |
521 @file{benchmark} library. See the functions @code{benchmark-run} and | |
522 @code{benchmark-run-compiled} in @file{benchmark.el}. | |
523 | |
524 @item | |
525 Use iteration rather than recursion whenever possible. | |
526 Function calls are slow in Emacs Lisp even when a compiled function | |
527 is calling another compiled function. | |
528 | |
529 @item | |
530 Using the primitive list-searching functions @code{memq}, @code{member}, | |
531 @code{assq}, or @code{assoc} is even faster than explicit iteration. It | |
532 can be worth rearranging a data structure so that one of these primitive | |
533 search functions can be used. | |
534 | |
535 @item | |
536 Certain built-in functions are handled specially in byte-compiled code, | |
537 avoiding the need for an ordinary function call. It is a good idea to | |
538 use these functions rather than alternatives. To see whether a function | |
539 is handled specially by the compiler, examine its @code{byte-compile} | |
540 property. If the property is non-@code{nil}, then the function is | |
541 handled specially. | |
542 | |
543 For example, the following input will show you that @code{aref} is | |
544 compiled specially (@pxref{Array Functions}): | |
545 | |
546 @example | |
547 @group | |
548 (get 'aref 'byte-compile) | |
549 @result{} byte-compile-two-args | |
550 @end group | |
551 @end example | |
552 | |
553 @item | |
554 If calling a small function accounts for a substantial part of your | |
555 program's running time, make the function inline. This eliminates | |
556 the function call overhead. Since making a function inline reduces | |
557 the flexibility of changing the program, don't do it unless it gives | |
558 a noticeable speedup in something slow enough that users care about | |
559 the speed. @xref{Inline Functions}. | |
560 @end itemize | |
561 | |
562 @node Warning Tips | |
563 @section Tips for Avoiding Compiler Warnings | |
564 @cindex byte compiler warnings, how to avoid | |
565 | |
566 @itemize @bullet | |
567 @item | |
568 Try to avoid compiler warnings about undefined free variables, by adding | |
569 dummy @code{defvar} definitions for these variables, like this: | |
570 | |
571 @example | |
572 (defvar foo) | |
573 @end example | |
574 | |
575 Such a definition has no effect except to tell the compiler | |
576 not to warn about uses of the variable @code{foo} in this file. | |
577 | |
578 @item | |
579 If you use many functions and variables from a certain file, you can | |
580 add a @code{require} for that package to avoid compilation warnings | |
581 for them. For instance, | |
582 | |
583 @example | |
584 (eval-when-compile | |
585 (require 'foo)) | |
586 @end example | |
587 | |
588 @item | |
589 If you bind a variable in one function, and use it or set it in | |
590 another function, the compiler warns about the latter function unless | |
591 the variable has a definition. But adding a definition would be | |
592 unclean if the variable has a short name, since Lisp packages should | |
593 not define short variable names. The right thing to do is to rename | |
594 this variable to start with the name prefix used for the other | |
595 functions and variables in your package. | |
596 | |
597 @item | |
598 The last resort for avoiding a warning, when you want to do something | |
599 that usually is a mistake but it's not a mistake in this one case, | |
600 is to put a call to @code{with-no-warnings} around it. | |
601 @end itemize | |
602 | |
603 @node Documentation Tips | |
604 @section Tips for Documentation Strings | |
605 @cindex documentation strings, conventions and tips | |
606 | |
607 @findex checkdoc-minor-mode | |
608 Here are some tips and conventions for the writing of documentation | |
609 strings. You can check many of these conventions by running the command | |
610 @kbd{M-x checkdoc-minor-mode}. | |
611 | |
612 @itemize @bullet | |
613 @item | |
614 Every command, function, or variable intended for users to know about | |
615 should have a documentation string. | |
616 | |
617 @item | |
618 An internal variable or subroutine of a Lisp program might as well have | |
619 a documentation string. In earlier Emacs versions, you could save space | |
620 by using a comment instead of a documentation string, but that is no | |
621 longer the case---documentation strings now take up very little space in | |
622 a running Emacs. | |
623 | |
624 @item | |
625 Format the documentation string so that it fits in an Emacs window on an | |
626 80-column screen. It is a good idea for most lines to be no wider than | |
627 60 characters. The first line should not be wider than 67 characters | |
628 or it will look bad in the output of @code{apropos}. | |
629 | |
630 You can fill the text if that looks good. However, rather than blindly | |
631 filling the entire documentation string, you can often make it much more | |
632 readable by choosing certain line breaks with care. Use blank lines | |
633 between topics if the documentation string is long. | |
634 | |
635 @item | |
636 The first line of the documentation string should consist of one or two | |
637 complete sentences that stand on their own as a summary. @kbd{M-x | |
638 apropos} displays just the first line, and if that line's contents don't | |
639 stand on their own, the result looks bad. In particular, start the | |
640 first line with a capital letter and end with a period. | |
641 | |
642 For a function, the first line should briefly answer the question, | |
643 ``What does this function do?'' For a variable, the first line should | |
644 briefly answer the question, ``What does this value mean?'' | |
645 | |
646 Don't limit the documentation string to one line; use as many lines as | |
647 you need to explain the details of how to use the function or | |
648 variable. Please use complete sentences for the rest of the text too. | |
649 | |
650 @item | |
651 When the user tries to use a disabled command, Emacs displays just the | |
652 first paragraph of its documentation string---everything through the | |
653 first blank line. If you wish, you can choose which information to | |
654 include before the first blank line so as to make this display useful. | |
655 | |
656 @item | |
657 The first line should mention all the important arguments of the | |
658 function, and should mention them in the order that they are written | |
659 in a function call. If the function has many arguments, then it is | |
660 not feasible to mention them all in the first line; in that case, the | |
661 first line should mention the first few arguments, including the most | |
662 important arguments. | |
663 | |
664 @item | |
665 When a function's documentation string mentions the value of an argument | |
666 of the function, use the argument name in capital letters as if it were | |
667 a name for that value. Thus, the documentation string of the function | |
668 @code{eval} refers to its second argument as @samp{FORM}, because the | |
669 actual argument name is @code{form}: | |
670 | |
671 @example | |
672 Evaluate FORM and return its value. | |
673 @end example | |
674 | |
675 Also write metasyntactic variables in capital letters, such as when you | |
676 show the decomposition of a list or vector into subunits, some of which | |
677 may vary. @samp{KEY} and @samp{VALUE} in the following example | |
678 illustrate this practice: | |
679 | |
680 @example | |
681 The argument TABLE should be an alist whose elements | |
682 have the form (KEY . VALUE). Here, KEY is ... | |
683 @end example | |
684 | |
685 @item | |
686 Never change the case of a Lisp symbol when you mention it in a doc | |
687 string. If the symbol's name is @code{foo}, write ``foo,'' not | |
688 ``Foo'' (which is a different symbol). | |
689 | |
690 This might appear to contradict the policy of writing function | |
691 argument values, but there is no real contradiction; the argument | |
692 @emph{value} is not the same thing as the @emph{symbol} which the | |
693 function uses to hold the value. | |
694 | |
695 If this puts a lower-case letter at the beginning of a sentence | |
696 and that annoys you, rewrite the sentence so that the symbol | |
697 is not at the start of it. | |
698 | |
699 @item | |
700 Do not start or end a documentation string with whitespace. | |
701 | |
702 @item | |
703 @strong{Do not} indent subsequent lines of a documentation string so | |
704 that the text is lined up in the source code with the text of the first | |
705 line. This looks nice in the source code, but looks bizarre when users | |
706 view the documentation. Remember that the indentation before the | |
707 starting double-quote is not part of the string! | |
708 | |
709 @anchor{Docstring hyperlinks} | |
710 @item | |
711 @iftex | |
712 When a documentation string refers to a Lisp symbol, write it as it | |
713 would be printed (which usually means in lower case), with single-quotes | |
714 around it. For example: @samp{`lambda'}. There are two exceptions: | |
715 write @code{t} and @code{nil} without single-quotes. | |
716 @end iftex | |
717 @ifnottex | |
718 When a documentation string refers to a Lisp symbol, write it as it | |
719 would be printed (which usually means in lower case), with single-quotes | |
720 around it. For example: @samp{lambda}. There are two exceptions: write | |
721 t and nil without single-quotes. (In this manual, we use a different | |
722 convention, with single-quotes for all symbols.) | |
723 @end ifnottex | |
724 | |
725 @cindex hyperlinks in documentation strings | |
726 Help mode automatically creates a hyperlink when a documentation string | |
727 uses a symbol name inside single quotes, if the symbol has either a | |
728 function or a variable definition. You do not need to do anything | |
729 special to make use of this feature. However, when a symbol has both a | |
730 function definition and a variable definition, and you want to refer to | |
731 just one of them, you can specify which one by writing one of the words | |
732 @samp{variable}, @samp{option}, @samp{function}, or @samp{command}, | |
733 immediately before the symbol name. (Case makes no difference in | |
734 recognizing these indicator words.) For example, if you write | |
735 | |
736 @example | |
737 This function sets the variable `buffer-file-name'. | |
738 @end example | |
739 | |
740 @noindent | |
741 then the hyperlink will refer only to the variable documentation of | |
742 @code{buffer-file-name}, and not to its function documentation. | |
743 | |
744 If a symbol has a function definition and/or a variable definition, but | |
745 those are irrelevant to the use of the symbol that you are documenting, | |
746 you can write the words @samp{symbol} or @samp{program} before the | |
747 symbol name to prevent making any hyperlink. For example, | |
748 | |
749 @example | |
750 If the argument KIND-OF-RESULT is the symbol `list', | |
751 this function returns a list of all the objects | |
752 that satisfy the criterion. | |
753 @end example | |
754 | |
755 @noindent | |
756 does not make a hyperlink to the documentation, irrelevant here, of the | |
757 function @code{list}. | |
758 | |
759 Normally, no hyperlink is made for a variable without variable | |
760 documentation. You can force a hyperlink for such variables by | |
761 preceding them with one of the words @samp{variable} or | |
762 @samp{option}. | |
763 | |
764 Hyperlinks for faces are only made if the face name is preceded or | |
765 followed by the word @samp{face}. In that case, only the face | |
766 documentation will be shown, even if the symbol is also defined as a | |
767 variable or as a function. | |
768 | |
769 To make a hyperlink to Info documentation, write the name of the Info | |
770 node (or anchor) in single quotes, preceded by @samp{info node}, | |
771 @samp{Info node}, @samp{info anchor} or @samp{Info anchor}. The Info | |
772 file name defaults to @samp{emacs}. For example, | |
773 | |
774 @smallexample | |
775 See Info node `Font Lock' and Info node `(elisp)Font Lock Basics'. | |
776 @end smallexample | |
777 | |
778 Finally, to create a hyperlink to URLs, write the URL in single | |
779 quotes, preceded by @samp{URL}. For example, | |
780 | |
781 @smallexample | |
782 The home page for the GNU project has more information (see URL | |
783 `http://www.gnu.org/'). | |
784 @end smallexample | |
785 | |
786 @item | |
787 Don't write key sequences directly in documentation strings. Instead, | |
788 use the @samp{\\[@dots{}]} construct to stand for them. For example, | |
789 instead of writing @samp{C-f}, write the construct | |
790 @samp{\\[forward-char]}. When Emacs displays the documentation string, | |
791 it substitutes whatever key is currently bound to @code{forward-char}. | |
792 (This is normally @samp{C-f}, but it may be some other character if the | |
793 user has moved key bindings.) @xref{Keys in Documentation}. | |
794 | |
795 @item | |
796 In documentation strings for a major mode, you will want to refer to the | |
797 key bindings of that mode's local map, rather than global ones. | |
798 Therefore, use the construct @samp{\\<@dots{}>} once in the | |
799 documentation string to specify which key map to use. Do this before | |
800 the first use of @samp{\\[@dots{}]}. The text inside the | |
801 @samp{\\<@dots{}>} should be the name of the variable containing the | |
802 local keymap for the major mode. | |
803 | |
804 It is not practical to use @samp{\\[@dots{}]} very many times, because | |
805 display of the documentation string will become slow. So use this to | |
806 describe the most important commands in your major mode, and then use | |
807 @samp{\\@{@dots{}@}} to display the rest of the mode's keymap. | |
808 | |
809 @item | |
810 For consistency, phrase the verb in the first sentence of a function's | |
811 documentation string as an imperative---for instance, use ``Return the | |
812 cons of A and B.'' in preference to ``Returns the cons of A and B@.'' | |
813 Usually it looks good to do likewise for the rest of the first | |
814 paragraph. Subsequent paragraphs usually look better if each sentence | |
815 is indicative and has a proper subject. | |
816 | |
817 @item | |
818 The documentation string for a function that is a yes-or-no predicate | |
819 should start with words such as ``Return t if,'' to indicate | |
820 explicitly what constitutes ``truth.'' The word ``return'' avoids | |
821 starting the sentence with lower-case ``t,'' which could be somewhat | |
822 distracting. | |
823 | |
824 @item | |
825 If a line in a documentation string begins with an open-parenthesis, | |
826 write a backslash before the open-parenthesis, like this: | |
827 | |
828 @example | |
829 The argument FOO can be either a number | |
830 \(a buffer position) or a string (a file name). | |
831 @end example | |
832 | |
833 This prevents the open-parenthesis from being treated as the start of a | |
834 defun (@pxref{Defuns,, Defuns, emacs, The GNU Emacs Manual}). | |
835 | |
836 @item | |
837 Write documentation strings in the active voice, not the passive, and in | |
838 the present tense, not the future. For instance, use ``Return a list | |
839 containing A and B.'' instead of ``A list containing A and B will be | |
840 returned.'' | |
841 | |
842 @item | |
843 Avoid using the word ``cause'' (or its equivalents) unnecessarily. | |
844 Instead of, ``Cause Emacs to display text in boldface,'' write just | |
845 ``Display text in boldface.'' | |
846 | |
847 @item | |
848 Avoid using ``iff'' (a mathematics term meaning ``if and only if''), | |
849 since many people are unfamiliar with it and mistake it for a typo. In | |
850 most cases, the meaning is clear with just ``if''. Otherwise, try to | |
851 find an alternate phrasing that conveys the meaning. | |
852 | |
853 @item | |
854 When a command is meaningful only in a certain mode or situation, | |
855 do mention that in the documentation string. For example, | |
856 the documentation of @code{dired-find-file} is: | |
857 | |
858 @example | |
859 In Dired, visit the file or directory named on this line. | |
860 @end example | |
861 | |
862 @item | |
863 When you define a variable that users ought to set interactively, you | |
864 normally should use @code{defcustom}. However, if for some reason you | |
865 use @code{defvar} instead, start the doc string with a @samp{*}. | |
866 @xref{Defining Variables}. | |
867 | |
868 @item | |
869 The documentation string for a variable that is a yes-or-no flag should | |
870 start with words such as ``Non-nil means,'' to make it clear that | |
871 all non-@code{nil} values are equivalent and indicate explicitly what | |
872 @code{nil} and non-@code{nil} mean. | |
873 @end itemize | |
874 | |
875 @node Comment Tips | |
876 @section Tips on Writing Comments | |
877 @cindex comments, Lisp convention for | |
878 | |
879 We recommend these conventions for where to put comments and how to | |
880 indent them: | |
881 | |
882 @table @samp | |
883 @item ; | |
884 Comments that start with a single semicolon, @samp{;}, should all be | |
885 aligned to the same column on the right of the source code. Such | |
886 comments usually explain how the code on the same line does its job. In | |
887 Lisp mode and related modes, the @kbd{M-;} (@code{indent-for-comment}) | |
888 command automatically inserts such a @samp{;} in the right place, or | |
889 aligns such a comment if it is already present. | |
890 | |
891 This and following examples are taken from the Emacs sources. | |
892 | |
893 @smallexample | |
894 @group | |
895 (setq base-version-list ; there was a base | |
896 (assoc (substring fn 0 start-vn) ; version to which | |
897 file-version-assoc-list)) ; this looks like | |
898 ; a subversion | |
899 @end group | |
900 @end smallexample | |
901 | |
902 @item ;; | |
903 Comments that start with two semicolons, @samp{;;}, should be aligned to | |
904 the same level of indentation as the code. Such comments usually | |
905 describe the purpose of the following lines or the state of the program | |
906 at that point. For example: | |
907 | |
908 @smallexample | |
909 @group | |
910 (prog1 (setq auto-fill-function | |
911 @dots{} | |
912 @dots{} | |
913 ;; update mode line | |
914 (force-mode-line-update))) | |
915 @end group | |
916 @end smallexample | |
917 | |
918 We also normally use two semicolons for comments outside functions. | |
919 | |
920 @smallexample | |
921 @group | |
922 ;; This Lisp code is run in Emacs | |
923 ;; when it is to operate as a server | |
924 ;; for other processes. | |
925 @end group | |
926 @end smallexample | |
927 | |
928 Every function that has no documentation string (presumably one that is | |
929 used only internally within the package it belongs to), should instead | |
930 have a two-semicolon comment right before the function, explaining what | |
931 the function does and how to call it properly. Explain precisely what | |
932 each argument means and how the function interprets its possible values. | |
933 | |
934 @item ;;; | |
935 Comments that start with three semicolons, @samp{;;;}, should start at | |
936 the left margin. These are used, occasionally, for comments within | |
937 functions that should start at the margin. We also use them sometimes | |
938 for comments that are between functions---whether to use two or three | |
939 semicolons depends on whether the comment should be considered a | |
940 ``heading'' by Outline minor mode. By default, comments starting with | |
941 at least three semicolons (followed by a single space and a | |
942 non-whitespace character) are considered headings, comments starting | |
943 with two or less are not. | |
944 | |
945 Another use for triple-semicolon comments is for commenting out lines | |
946 within a function. We use three semicolons for this precisely so that | |
947 they remain at the left margin. By default, Outline minor mode does | |
948 not consider a comment to be a heading (even if it starts with at | |
949 least three semicolons) if the semicolons are followed by at least two | |
950 spaces. Thus, if you add an introductory comment to the commented out | |
951 code, make sure to indent it by at least two spaces after the three | |
952 semicolons. | |
953 | |
954 @smallexample | |
955 (defun foo (a) | |
956 ;;; This is no longer necessary. | |
957 ;;; (force-mode-line-update) | |
958 (message "Finished with %s" a)) | |
959 @end smallexample | |
960 | |
961 When commenting out entire functions, use two semicolons. | |
962 | |
963 @item ;;;; | |
964 Comments that start with four semicolons, @samp{;;;;}, should be aligned | |
965 to the left margin and are used for headings of major sections of a | |
966 program. For example: | |
967 | |
968 @smallexample | |
969 ;;;; The kill ring | |
970 @end smallexample | |
971 @end table | |
972 | |
973 @noindent | |
974 The indentation commands of the Lisp modes in Emacs, such as @kbd{M-;} | |
975 (@code{indent-for-comment}) and @key{TAB} (@code{lisp-indent-line}), | |
976 automatically indent comments according to these conventions, | |
977 depending on the number of semicolons. @xref{Comments,, | |
978 Manipulating Comments, emacs, The GNU Emacs Manual}. | |
979 | |
980 @node Library Headers | |
981 @section Conventional Headers for Emacs Libraries | |
982 @cindex header comments | |
983 @cindex library header comments | |
984 | |
985 Emacs has conventions for using special comments in Lisp libraries | |
986 to divide them into sections and give information such as who wrote | |
987 them. This section explains these conventions. | |
988 | |
989 We'll start with an example, a package that is included in the Emacs | |
990 distribution. | |
991 | |
992 Parts of this example reflect its status as part of Emacs; for | |
993 example, the copyright notice lists the Free Software Foundation as the | |
994 copyright holder, and the copying permission says the file is part of | |
995 Emacs. When you write a package and post it, the copyright holder would | |
996 be you (unless your employer claims to own it instead), and you should | |
997 get the suggested copying permission from the end of the GNU General | |
998 Public License itself. Don't say your file is part of Emacs | |
999 if we haven't installed it in Emacs yet! | |
1000 | |
1001 With that warning out of the way, on to the example: | |
1002 | |
1003 @smallexample | |
1004 @group | |
1005 ;;; lisp-mnt.el --- minor mode for Emacs Lisp maintainers | |
1006 | |
1007 ;; Copyright (C) 1992 Free Software Foundation, Inc. | |
1008 @end group | |
1009 | |
1010 ;; Author: Eric S. Raymond <esr@@snark.thyrsus.com> | |
1011 ;; Maintainer: Eric S. Raymond <esr@@snark.thyrsus.com> | |
1012 ;; Created: 14 Jul 1992 | |
1013 ;; Version: 1.2 | |
1014 @group | |
1015 ;; Keywords: docs | |
1016 | |
1017 ;; This file is part of GNU Emacs. | |
1018 @dots{} | |
1019 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, | |
1020 ;; Boston, MA 02110-1301, USA. | |
1021 @end group | |
1022 @end smallexample | |
1023 | |
1024 The very first line should have this format: | |
1025 | |
1026 @example | |
1027 ;;; @var{filename} --- @var{description} | |
1028 @end example | |
1029 | |
1030 @noindent | |
1031 The description should be complete in one line. If the file | |
1032 needs a @samp{-*-} specification, put it after @var{description}. | |
1033 | |
1034 After the copyright notice come several @dfn{header comment} lines, | |
1035 each beginning with @samp{;; @var{header-name}:}. Here is a table of | |
1036 the conventional possibilities for @var{header-name}: | |
1037 | |
1038 @table @samp | |
1039 @item Author | |
1040 This line states the name and net address of at least the principal | |
1041 author of the library. | |
1042 | |
1043 If there are multiple authors, you can list them on continuation lines | |
1044 led by @code{;;} and a tab character, like this: | |
1045 | |
1046 @smallexample | |
1047 @group | |
1048 ;; Author: Ashwin Ram <Ram-Ashwin@@cs.yale.edu> | |
1049 ;; Dave Sill <de5@@ornl.gov> | |
1050 ;; Dave Brennan <brennan@@hal.com> | |
1051 ;; Eric Raymond <esr@@snark.thyrsus.com> | |
1052 @end group | |
1053 @end smallexample | |
1054 | |
1055 @item Maintainer | |
1056 This line should contain a single name/address as in the Author line, or | |
1057 an address only, or the string @samp{FSF}. If there is no maintainer | |
1058 line, the person(s) in the Author field are presumed to be the | |
1059 maintainers. The example above is mildly bogus because the maintainer | |
1060 line is redundant. | |
1061 | |
1062 The idea behind the @samp{Author} and @samp{Maintainer} lines is to make | |
1063 possible a Lisp function to ``send mail to the maintainer'' without | |
1064 having to mine the name out by hand. | |
1065 | |
1066 Be sure to surround the network address with @samp{<@dots{}>} if | |
1067 you include the person's full name as well as the network address. | |
1068 | |
1069 @item Created | |
1070 This optional line gives the original creation date of the | |
1071 file. For historical interest only. | |
1072 | |
1073 @item Version | |
1074 If you wish to record version numbers for the individual Lisp program, put | |
1075 them in this line. | |
1076 | |
1077 @item Adapted-By | |
1078 In this header line, place the name of the person who adapted the | |
1079 library for installation (to make it fit the style conventions, for | |
1080 example). | |
1081 | |
1082 @item Keywords | |
1083 This line lists keywords for the @code{finder-by-keyword} help command. | |
1084 Please use that command to see a list of the meaningful keywords. | |
1085 | |
1086 This field is important; it's how people will find your package when | |
1087 they're looking for things by topic area. To separate the keywords, you | |
1088 can use spaces, commas, or both. | |
1089 @end table | |
1090 | |
1091 Just about every Lisp library ought to have the @samp{Author} and | |
1092 @samp{Keywords} header comment lines. Use the others if they are | |
1093 appropriate. You can also put in header lines with other header | |
1094 names---they have no standard meanings, so they can't do any harm. | |
1095 | |
1096 We use additional stylized comments to subdivide the contents of the | |
1097 library file. These should be separated by blank lines from anything | |
1098 else. Here is a table of them: | |
1099 | |
1100 @table @samp | |
1101 @item ;;; Commentary: | |
1102 This begins introductory comments that explain how the library works. | |
1103 It should come right after the copying permissions, terminated by a | |
1104 @samp{Change Log}, @samp{History} or @samp{Code} comment line. This | |
1105 text is used by the Finder package, so it should make sense in that | |
1106 context. | |
1107 | |
1108 @item ;;; Documentation: | |
1109 This was used in some files in place of @samp{;;; Commentary:}, | |
1110 but it is deprecated. | |
1111 | |
1112 @item ;;; Change Log: | |
1113 This begins change log information stored in the library file (if you | |
1114 store the change history there). For Lisp files distributed with Emacs, | |
1115 the change history is kept in the file @file{ChangeLog} and not in the | |
1116 source file at all; these files generally do not have a @samp{;;; Change | |
1117 Log:} line. @samp{History} is an alternative to @samp{Change Log}. | |
1118 | |
1119 @item ;;; Code: | |
1120 This begins the actual code of the program. | |
1121 | |
1122 @item ;;; @var{filename} ends here | |
1123 This is the @dfn{footer line}; it appears at the very end of the file. | |
1124 Its purpose is to enable people to detect truncated versions of the file | |
1125 from the lack of a footer line. | |
1126 @end table | |
1127 | |
1128 @ignore | |
1129 arch-tag: 9ea911c2-6b1d-47dd-88b7-0a94e8b27c2e | |
1130 @end ignore |