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