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