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