Mercurial > emacs
annotate lispref/tips.texi @ 42843:49c29a684355
Describe global-hl-line-mode.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Sun, 20 Jan 2002 09:27:57 +0000 |
parents | fb31125d0d7b |
children | 7359d6d75a9c |
rev | line source |
---|---|
6552 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
27189 | 3 @c Copyright (C) 1990, 1991, 1992, 1993, 1995, 1998, 1999 |
4 @c 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. |
6552 | 26 * Compilation Tips:: Making compiled code run fast. |
27 * Documentation Tips:: Writing readable documentation strings. | |
28 * Comment Tips:: Conventions for writing comments. | |
29 * Library Headers:: Standard headers for library packages. | |
30 @end menu | |
31 | |
17280
96762d1abb7c
(Coding Conventions): Node renamed from Style Tips.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
32 @node Coding Conventions |
96762d1abb7c
(Coding Conventions): Node renamed from Style Tips.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
33 @section Emacs Lisp Coding Conventions |
6552 | 34 |
17280
96762d1abb7c
(Coding Conventions): Node renamed from Style Tips.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
35 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
|
36 code intended for widespread use: |
6552 | 37 |
38 @itemize @bullet | |
39 @item | |
38162 | 40 Since all global variables share the same name space, and all |
41 functions share another name space, you should choose a short word to | |
42 distinguish your program from other Lisp programs.@footnote{The | |
43 benefits of a Common Lisp-style package system are considered not to | |
44 outweigh the costs.} Then take care to begin the names of all global | |
45 variables, constants, and functions in your program with the chosen | |
46 prefix. This helps avoid name conflicts. | |
6552 | 47 |
48 This recommendation applies even to names for traditional Lisp | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
49 primitives that are not primitives in Emacs Lisp---even to |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
50 @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
|
51 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
|
52 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
|
53 instead. |
6552 | 54 |
55 If you write a function that you think ought to be added to Emacs under | |
56 a certain name, such as @code{twiddle-files}, don't call it by that name | |
57 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
|
58 and send mail to @samp{bug-gnu-emacs@@gnu.org} suggesting we add |
6552 | 59 it to Emacs. If and when we do, we can change the name easily enough. |
60 | |
61 If one prefix is insufficient, your package may use two or three | |
62 alternative common prefixes, so long as they make sense. | |
63 | |
64 Separate the prefix from the rest of the symbol name with a hyphen, | |
65 @samp{-}. This will be consistent with Emacs itself and with most Emacs | |
66 Lisp programs. | |
67 | |
68 @item | |
69 It is often useful to put a call to @code{provide} in each separate | |
70 library program, at least if there is more than one entry point to the | |
71 program. | |
72 | |
73 @item | |
12098 | 74 If a file requires certain other library programs to be loaded |
75 beforehand, then the comments at the beginning of the file should say | |
76 so. Also, use @code{require} to make sure they are loaded. | |
77 | |
78 @item | |
6552 | 79 If one file @var{foo} uses a macro defined in another file @var{bar}, |
12098 | 80 @var{foo} should contain this expression before the first use of the |
81 macro: | |
82 | |
83 @example | |
84 (eval-when-compile (require '@var{bar})) | |
85 @end example | |
86 | |
87 @noindent | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
88 (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
|
89 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
|
90 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
|
91 @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
|
92 compiled code that won't work right. @xref{Compiling Macros}. |
12098 | 93 |
94 Using @code{eval-when-compile} avoids loading @var{bar} when | |
95 the compiled version of @var{foo} is @emph{used}. | |
6552 | 96 |
97 @item | |
24799 | 98 Please don't require the @code{cl} package of Common Lisp extensions at |
99 run time. Use of this package is optional, and it is not part of the | |
100 standard Emacs namespace. If your package loads @code{cl} at run time, | |
101 that could cause name clashes for users who don't use that package. | |
102 | |
103 However, there is no problem with using the @code{cl} package at compile | |
104 time, for the sake of macros. You do that like this: | |
105 | |
106 @example | |
107 (eval-when-compile (require 'cl)) | |
108 @end example | |
109 | |
110 @item | |
17280
96762d1abb7c
(Coding Conventions): Node renamed from Style Tips.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
111 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
|
112 conventions. @xref{Major Mode Conventions}. |
96762d1abb7c
(Coding Conventions): Node renamed from Style Tips.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
113 |
96762d1abb7c
(Coding Conventions): Node renamed from Style Tips.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
114 @item |
96762d1abb7c
(Coding Conventions): Node renamed from Style Tips.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
115 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
|
116 conventions. @xref{Minor Mode Conventions}. |
6552 | 117 |
118 @item | |
9807
d5fa87d62d62
Add function and variable name conventions.
Richard M. Stallman <rms@gnu.org>
parents:
9393
diff
changeset
|
119 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
|
120 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
|
121 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
|
122 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
|
123 |
d5fa87d62d62
Add function and variable name conventions.
Richard M. Stallman <rms@gnu.org>
parents:
9393
diff
changeset
|
124 @item |
d5fa87d62d62
Add function and variable name conventions.
Richard M. Stallman <rms@gnu.org>
parents:
9393
diff
changeset
|
125 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
|
126 name that ends in @samp{-flag}. |
d5fa87d62d62
Add function and variable name conventions.
Richard M. Stallman <rms@gnu.org>
parents:
9393
diff
changeset
|
127 |
d5fa87d62d62
Add function and variable name conventions.
Richard M. Stallman <rms@gnu.org>
parents:
9393
diff
changeset
|
128 @item |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
129 @cindex reserved keys |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
130 @cindex keys, reserved |
6552 | 131 Please do not define @kbd{C-c @var{letter}} as a key in your major |
132 modes. These sequences are reserved for users; they are the | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
133 @strong{only} sequences reserved for users, so do not block them. |
6552 | 134 |
14394
289506921917
Clarify key sequence usage conventions.
Richard M. Stallman <rms@gnu.org>
parents:
14028
diff
changeset
|
135 Instead, define sequences consisting of @kbd{C-c} followed by a control |
289506921917
Clarify key sequence usage conventions.
Richard M. Stallman <rms@gnu.org>
parents:
14028
diff
changeset
|
136 character, a digit, or certain punctuation characters. These sequences |
289506921917
Clarify key sequence usage conventions.
Richard M. Stallman <rms@gnu.org>
parents:
14028
diff
changeset
|
137 are reserved for major modes. |
6552 | 138 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
139 Changing all the Emacs major modes to follow this convention was a lot |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
140 of work. Abandoning this convention would make that work go to waste, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
141 and inconvenience users. |
11648
e09e51d7c35a
Describe uses of C-c followed by punctuation chars.
Richard M. Stallman <rms@gnu.org>
parents:
10229
diff
changeset
|
142 |
e09e51d7c35a
Describe uses of C-c followed by punctuation chars.
Richard M. Stallman <rms@gnu.org>
parents:
10229
diff
changeset
|
143 @item |
e09e51d7c35a
Describe uses of C-c followed by punctuation chars.
Richard M. Stallman <rms@gnu.org>
parents:
10229
diff
changeset
|
144 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
|
145 @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
|
146 |
e09e51d7c35a
Describe uses of C-c followed by punctuation chars.
Richard M. Stallman <rms@gnu.org>
parents:
10229
diff
changeset
|
147 @item |
e09e51d7c35a
Describe uses of C-c followed by punctuation chars.
Richard M. Stallman <rms@gnu.org>
parents:
10229
diff
changeset
|
148 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
|
149 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
|
150 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
|
151 may be shadowed from time to time by minor modes. |
6552 | 152 |
153 @item | |
19361
8546df4cb304
Reserve some function keys for users.
Richard M. Stallman <rms@gnu.org>
parents:
17280
diff
changeset
|
154 Function keys @key{F5} through @key{F9} without modifier keys are |
8546df4cb304
Reserve some function keys for users.
Richard M. Stallman <rms@gnu.org>
parents:
17280
diff
changeset
|
155 reserved for users to define. |
8546df4cb304
Reserve some function keys for users.
Richard M. Stallman <rms@gnu.org>
parents:
17280
diff
changeset
|
156 |
8546df4cb304
Reserve some function keys for users.
Richard M. Stallman <rms@gnu.org>
parents:
17280
diff
changeset
|
157 @item |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
158 Do not bind @kbd{C-h} following any prefix character (including |
6552 | 159 @kbd{C-c}). If you don't bind @kbd{C-h}, it is automatically available |
160 as a help character for listing the subcommands of the prefix character. | |
161 | |
162 @item | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
163 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
|
164 another @key{ESC}. (That is, it is OK to bind a sequence ending in |
6552 | 165 @kbd{@key{ESC} @key{ESC}}.) |
166 | |
167 The reason for this rule is that a non-prefix binding for @key{ESC} in | |
168 any context prevents recognition of escape sequences as function keys in | |
169 that context. | |
170 | |
171 @item | |
22635
1e9786a5c63d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
172 Anything which acts like a temporary mode or state which the user can |
24862 | 173 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
|
174 @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
|
175 |
1e9786a5c63d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
176 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
|
177 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
|
178 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
|
179 @key{ESC}}, since that would preclude recognizing an escape sequence |
1e9786a5c63d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
180 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
|
181 @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
|
182 @kbd{@key{ESC} @key{ESC}} instead. |
1e9786a5c63d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
183 |
1e9786a5c63d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
184 @item |
6959
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
185 Applications should not bind mouse events based on button 1 with the |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
186 shift key held down. These events include @kbd{S-mouse-1}, |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
187 @kbd{M-S-mouse-1}, @kbd{C-S-mouse-1}, and so on. They are reserved for |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
188 users. |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
189 |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
190 @item |
34305 | 191 @cindex mouse-2 |
192 @cindex references, following | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
193 Special major modes used for read-only text should usually redefine |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
194 @kbd{mouse-2} and @key{RET} to trace some sort of reference in the text. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
195 Modes such as Dired, Info, Compilation, and Occur redefine it in this |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
196 way. |
6959
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
197 |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
198 @item |
9393
0bec3b6bac2f
Add a tip about enabling/disabling features.
Richard M. Stallman <rms@gnu.org>
parents:
8669
diff
changeset
|
199 When a package provides a modification of ordinary Emacs behavior, it is |
40561
ec17075b77aa
(Coding Conventions): Fix typo.
Pavel Janík <Pavel@Janik.cz>
parents:
40517
diff
changeset
|
200 good to include a command to enable and disable the feature, provide a |
9393
0bec3b6bac2f
Add a tip about enabling/disabling features.
Richard M. Stallman <rms@gnu.org>
parents:
8669
diff
changeset
|
201 command named @code{@var{whatever}-mode} which turns the feature on or |
0bec3b6bac2f
Add a tip about enabling/disabling features.
Richard M. Stallman <rms@gnu.org>
parents:
8669
diff
changeset
|
202 off, and make it autoload (@pxref{Autoload}). Design the package so |
0bec3b6bac2f
Add a tip about enabling/disabling features.
Richard M. Stallman <rms@gnu.org>
parents:
8669
diff
changeset
|
203 that simply loading it has no visible effect---that should not enable |
34305 | 204 the feature.@footnote{Consider that the package may be loaded |
205 arbitrarily by Custom for instance.} Users will request the feature by | |
206 invoking the command. | |
9393
0bec3b6bac2f
Add a tip about enabling/disabling features.
Richard M. Stallman <rms@gnu.org>
parents:
8669
diff
changeset
|
207 |
0bec3b6bac2f
Add a tip about enabling/disabling features.
Richard M. Stallman <rms@gnu.org>
parents:
8669
diff
changeset
|
208 @item |
0bec3b6bac2f
Add a tip about enabling/disabling features.
Richard M. Stallman <rms@gnu.org>
parents:
8669
diff
changeset
|
209 It is a bad idea to define aliases for the Emacs primitives. Use the |
0bec3b6bac2f
Add a tip about enabling/disabling features.
Richard M. Stallman <rms@gnu.org>
parents:
8669
diff
changeset
|
210 standard names instead. |
6552 | 211 |
212 @item | |
34305 | 213 If a package needs to define an alias or a new function for |
38344 | 214 compatibility with some other version of Emacs, name it with the package |
34305 | 215 prefix, not with the raw name with which it occurs in the other version. |
216 Here is an example from Gnus, which provides many examples of such | |
217 compatibility issues. | |
218 | |
219 @example | |
220 (defalias 'gnus-point-at-bol | |
221 (if (fboundp 'point-at-bol) | |
222 'point-at-bol | |
223 'line-beginning-position)) | |
224 @end example | |
225 | |
226 @item | |
17280
96762d1abb7c
(Coding Conventions): Node renamed from Style Tips.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
227 Redefining (or advising) an Emacs primitive is discouraged. It may do |
96762d1abb7c
(Coding Conventions): Node renamed from Style Tips.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
228 the right thing for a particular program, but there is no telling what |
96762d1abb7c
(Coding Conventions): Node renamed from Style Tips.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
229 other programs might break as a result. |
6552 | 230 |
231 @item | |
232 If a file does replace any of the functions or library programs of | |
233 standard Emacs, prominent comments at the beginning of the file should | |
234 say which functions are replaced, and how the behavior of the | |
235 replacements differs from that of the originals. | |
236 | |
237 @item | |
238 Please keep the names of your Emacs Lisp source files to 13 characters | |
239 or less. This way, if the files are compiled, the compiled files' names | |
240 will be 14 characters or less, which is short enough to fit on all kinds | |
241 of Unix systems. | |
242 | |
243 @item | |
244 Don't use @code{next-line} or @code{previous-line} in programs; nearly | |
245 always, @code{forward-line} is more convenient as well as more | |
246 predictable and robust. @xref{Text Lines}. | |
247 | |
248 @item | |
7601
c5927c75b2b5
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6959
diff
changeset
|
249 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
|
250 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
|
251 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
|
252 for the user's benefit. @xref{The Mark}. |
6552 | 253 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
254 In particular, don't use any of these functions: |
6552 | 255 |
256 @itemize @bullet | |
257 @item | |
258 @code{beginning-of-buffer}, @code{end-of-buffer} | |
259 @item | |
260 @code{replace-string}, @code{replace-regexp} | |
261 @end itemize | |
262 | |
263 If you just want to move point, or replace a certain string, without any | |
264 of the other features intended for interactive users, you can replace | |
265 these functions with one or two lines of simple Lisp code. | |
266 | |
267 @item | |
8669 | 268 Use lists rather than vectors, except when there is a particular reason |
269 to use a vector. Lisp has more facilities for manipulating lists than | |
270 for vectors, and working with lists is usually more convenient. | |
271 | |
272 Vectors are advantageous for tables that are substantial in size and are | |
273 accessed in random order (not searched front to back), provided there is | |
274 no need to insert or delete elements (only lists allow that). | |
275 | |
276 @item | |
6552 | 277 The recommended way to print a message in the echo area is with |
278 the @code{message} function, not @code{princ}. @xref{The Echo Area}. | |
279 | |
280 @item | |
281 When you encounter an error condition, call the function @code{error} | |
282 (or @code{signal}). The function @code{error} does not return. | |
283 @xref{Signaling Errors}. | |
284 | |
285 Do not use @code{message}, @code{throw}, @code{sleep-for}, | |
286 or @code{beep} to report errors. | |
287 | |
288 @item | |
12098 | 289 An error message should start with a capital letter but should not end |
290 with a period. | |
291 | |
292 @item | |
38043
3577e0c41a1e
Give advice about how to default position args and region args.
Richard M. Stallman <rms@gnu.org>
parents:
34305
diff
changeset
|
293 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
|
294 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
|
295 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
|
296 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
|
297 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
|
298 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
|
299 |
3577e0c41a1e
Give advice about how to default position args and region args.
Richard M. Stallman <rms@gnu.org>
parents:
34305
diff
changeset
|
300 @example |
3577e0c41a1e
Give advice about how to default position args and region args.
Richard M. Stallman <rms@gnu.org>
parents:
34305
diff
changeset
|
301 (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
|
302 (interactive |
3577e0c41a1e
Give advice about how to default position args and region args.
Richard M. Stallman <rms@gnu.org>
parents:
34305
diff
changeset
|
303 (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
|
304 (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
|
305 ...) |
3577e0c41a1e
Give advice about how to default position args and region args.
Richard M. Stallman <rms@gnu.org>
parents:
34305
diff
changeset
|
306 @end example |
3577e0c41a1e
Give advice about how to default position args and region args.
Richard M. Stallman <rms@gnu.org>
parents:
34305
diff
changeset
|
307 |
3577e0c41a1e
Give advice about how to default position args and region args.
Richard M. Stallman <rms@gnu.org>
parents:
34305
diff
changeset
|
308 @noindent |
3577e0c41a1e
Give advice about how to default position args and region args.
Richard M. Stallman <rms@gnu.org>
parents:
34305
diff
changeset
|
309 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
|
310 |
3577e0c41a1e
Give advice about how to default position args and region args.
Richard M. Stallman <rms@gnu.org>
parents:
34305
diff
changeset
|
311 @example |
3577e0c41a1e
Give advice about how to default position args and region args.
Richard M. Stallman <rms@gnu.org>
parents:
34305
diff
changeset
|
312 (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
|
313 (interactive |
3577e0c41a1e
Give advice about how to default position args and region args.
Richard M. Stallman <rms@gnu.org>
parents:
34305
diff
changeset
|
314 (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
|
315 @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
|
316 ...) |
3577e0c41a1e
Give advice about how to default position args and region args.
Richard M. Stallman <rms@gnu.org>
parents:
34305
diff
changeset
|
317 @end example |
3577e0c41a1e
Give advice about how to default position args and region args.
Richard M. Stallman <rms@gnu.org>
parents:
34305
diff
changeset
|
318 |
3577e0c41a1e
Give advice about how to default position args and region args.
Richard M. Stallman <rms@gnu.org>
parents:
34305
diff
changeset
|
319 @noindent |
3577e0c41a1e
Give advice about how to default position args and region args.
Richard M. Stallman <rms@gnu.org>
parents:
34305
diff
changeset
|
320 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
|
321 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
|
322 |
3577e0c41a1e
Give advice about how to default position args and region args.
Richard M. Stallman <rms@gnu.org>
parents:
34305
diff
changeset
|
323 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
|
324 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
|
325 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
|
326 command. |
3577e0c41a1e
Give advice about how to default position args and region args.
Richard M. Stallman <rms@gnu.org>
parents:
34305
diff
changeset
|
327 |
3577e0c41a1e
Give advice about how to default position args and region args.
Richard M. Stallman <rms@gnu.org>
parents:
34305
diff
changeset
|
328 @item |
13893
2576d1142ed3
Explain style of "done" messages.
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
329 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
|
330 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
|
331 @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
|
332 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
|
333 @emph{no} period after @samp{done}. |
13893
2576d1142ed3
Explain style of "done" messages.
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
334 |
2576d1142ed3
Explain style of "done" messages.
Richard M. Stallman <rms@gnu.org>
parents:
12098
diff
changeset
|
335 @item |
6959
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
336 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
|
337 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
|
338 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
|
339 @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
|
340 user switch back at will. @xref{Recursive Editing}. |
6552 | 341 |
342 @item | |
343 In some other systems there is a convention of choosing variable names | |
344 that begin and end with @samp{*}. We don't use that convention in Emacs | |
6959
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
345 Lisp, so please don't use it in your programs. (Emacs uses such names |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
346 only for special-purpose buffers.) The users will find Emacs more |
6959
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
347 coherent if all libraries use the same conventions. |
6552 | 348 |
349 @item | |
14028
e8d6c760f796
Explain eliminating compiler warnings about undefined variables.
Richard M. Stallman <rms@gnu.org>
parents:
13893
diff
changeset
|
350 Try to avoid compiler warnings about undefined free variables, by adding |
15198 | 351 @code{defvar} definitions for these variables. |
14028
e8d6c760f796
Explain eliminating compiler warnings about undefined variables.
Richard M. Stallman <rms@gnu.org>
parents:
13893
diff
changeset
|
352 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
353 Sometimes adding a @code{require} for another package is useful to avoid |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
354 compilation warnings for variables and functions defined in that |
26211 | 355 package. If you do this, often it is better if the @code{require} acts |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
356 only at compile time. Here's how to do that: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
357 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
358 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
359 (eval-when-compile |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
360 (require 'foo) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
361 (defvar bar-baz)) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
362 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
363 |
14028
e8d6c760f796
Explain eliminating compiler warnings about undefined variables.
Richard M. Stallman <rms@gnu.org>
parents:
13893
diff
changeset
|
364 If you bind a variable in one function, and use it or set it in another |
e8d6c760f796
Explain eliminating compiler warnings about undefined variables.
Richard M. Stallman <rms@gnu.org>
parents:
13893
diff
changeset
|
365 function, the compiler warns about the latter function unless the |
e8d6c760f796
Explain eliminating compiler warnings about undefined variables.
Richard M. Stallman <rms@gnu.org>
parents:
13893
diff
changeset
|
366 variable has a definition. But often these variables have short names, |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
367 and it is not clean for Lisp packages to define such variable names. |
14028
e8d6c760f796
Explain eliminating compiler warnings about undefined variables.
Richard M. Stallman <rms@gnu.org>
parents:
13893
diff
changeset
|
368 Therefore, you should rename the variable to start with the name prefix |
e8d6c760f796
Explain eliminating compiler warnings about undefined variables.
Richard M. Stallman <rms@gnu.org>
parents:
13893
diff
changeset
|
369 used for the other functions and variables in your package. |
e8d6c760f796
Explain eliminating compiler warnings about undefined variables.
Richard M. Stallman <rms@gnu.org>
parents:
13893
diff
changeset
|
370 |
e8d6c760f796
Explain eliminating compiler warnings about undefined variables.
Richard M. Stallman <rms@gnu.org>
parents:
13893
diff
changeset
|
371 @item |
6552 | 372 Indent each function with @kbd{C-M-q} (@code{indent-sexp}) using the |
373 default indentation parameters. | |
374 | |
375 @item | |
376 Don't make a habit of putting close-parentheses on lines by themselves; | |
377 Lisp programmers find this disconcerting. Once in a while, when there | |
378 is a sequence of many consecutive close-parentheses, it may make sense | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
379 to split the sequence in one or two significant places. |
6552 | 380 |
381 @item | |
382 Please put a copyright notice on the file if you give copies to anyone. | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
383 Use a message like this one: |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
384 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
385 @smallexample |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
386 ;; Copyright (C) @var{year} @var{name} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
387 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
388 ;; This program is free software; you can redistribute it and/or |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
389 ;; modify it under the terms of the GNU General Public License as |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
390 ;; published by the Free Software Foundation; either version 2 of |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
391 ;; the License, or (at your option) any later version. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
392 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
393 ;; This program is distributed in the hope that it will be |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
394 ;; useful, but WITHOUT ANY WARRANTY; without even the implied |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
395 ;; warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
396 ;; PURPOSE. See the GNU General Public License for more details. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
397 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
398 ;; You should have received a copy of the GNU General Public |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
399 ;; License along with this program; if not, write to the Free |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
400 ;; Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
401 ;; MA 02111-1307 USA |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
402 @end smallexample |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
403 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
404 If you have signed papers to assign the copyright to the Foundation, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
405 then use @samp{Free Software Foundation, Inc.} as @var{name}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
406 Otherwise, use your name. |
6552 | 407 @end itemize |
408 | |
409 @node Compilation Tips | |
410 @section Tips for Making Compiled Code Fast | |
411 @cindex execution speed | |
412 @cindex speedups | |
413 | |
414 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
|
415 Lisp programs. |
6552 | 416 |
417 @itemize @bullet | |
418 @item | |
419 @cindex profiling | |
420 @cindex timing programs | |
421 @cindex @file{profile.el} | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
422 @cindex @file{elp.el} |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
423 Profile your program with the @file{profile} library or the @file{elp} |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
424 library. See the files @file{profile.el} and @file{elp.el} for |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
425 instructions. |
6552 | 426 |
427 @item | |
428 Use iteration rather than recursion whenever possible. | |
429 Function calls are slow in Emacs Lisp even when a compiled function | |
430 is calling another compiled function. | |
431 | |
432 @item | |
12098 | 433 Using the primitive list-searching functions @code{memq}, @code{member}, |
434 @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
|
435 can be worth rearranging a data structure so that one of these primitive |
12098 | 436 search functions can be used. |
6552 | 437 |
438 @item | |
6959
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
439 Certain built-in functions are handled specially in byte-compiled code, |
6552 | 440 avoiding the need for an ordinary function call. It is a good idea to |
441 use these functions rather than alternatives. To see whether a function | |
442 is handled specially by the compiler, examine its @code{byte-compile} | |
443 property. If the property is non-@code{nil}, then the function is | |
444 handled specially. | |
445 | |
446 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
|
447 compiled specially (@pxref{Array Functions}): |
6552 | 448 |
6959
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
449 @example |
6552 | 450 @group |
451 (get 'aref 'byte-compile) | |
452 @result{} byte-compile-two-args | |
453 @end group | |
6959
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
454 @end example |
6552 | 455 |
456 @item | |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
457 If calling a small function accounts for a substantial part of your |
6552 | 458 program's running time, make the function inline. This eliminates |
459 the function call overhead. Since making a function inline reduces | |
460 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
|
461 a noticeable speedup in something slow enough that users care about |
6552 | 462 the speed. @xref{Inline Functions}. |
463 @end itemize | |
464 | |
465 @node Documentation Tips | |
466 @section Tips for Documentation Strings | |
467 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
468 @findex checkdoc-minor-mode |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
469 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
|
470 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
|
471 @kbd{M-x checkdoc-minor-mode}. |
6552 | 472 |
473 @itemize @bullet | |
474 @item | |
7601
c5927c75b2b5
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6959
diff
changeset
|
475 Every command, function, or variable intended for users to know about |
6552 | 476 should have a documentation string. |
477 | |
478 @item | |
10225
2e5dcd5f3090
Recommend doc strings for all functions and variables.
Richard M. Stallman <rms@gnu.org>
parents:
9807
diff
changeset
|
479 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
|
480 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
|
481 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
|
482 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
|
483 a running Emacs. |
6552 | 484 |
485 @item | |
486 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
|
487 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
|
488 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
|
489 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
|
490 first line with a capital letter and end with a period. |
6552 | 491 |
40970
fb31125d0d7b
Say what questions first line of doc string should answer.
Richard M. Stallman <rms@gnu.org>
parents:
40561
diff
changeset
|
492 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
|
493 ``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
|
494 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
|
495 |
fb31125d0d7b
Say what questions first line of doc string should answer.
Richard M. Stallman <rms@gnu.org>
parents:
40561
diff
changeset
|
496 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
|
497 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
|
498 variable. Please use complete sentences for the rest of the text too. |
6552 | 499 |
500 @item | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
501 For consistency, phrase the verb in the first sentence of a function's |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
502 documentation string as an imperative--for instance, use ``Return the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
503 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
|
504 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
|
505 paragraph. Subsequent paragraphs usually look better if each sentence |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
506 has a proper subject. |
6959
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
507 |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
508 @item |
6552 | 509 Write documentation strings in the active voice, not the passive, and in |
510 the present tense, not the future. For instance, use ``Return a list | |
511 containing A and B.'' instead of ``A list containing A and B will be | |
512 returned.'' | |
513 | |
514 @item | |
515 Avoid using the word ``cause'' (or its equivalents) unnecessarily. | |
516 Instead of, ``Cause Emacs to display text in boldface,'' write just | |
517 ``Display text in boldface.'' | |
518 | |
519 @item | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
520 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
|
521 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
|
522 the documentation of @code{dired-find-file} is: |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
523 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
524 @example |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
525 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
|
526 @end example |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
527 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
528 @item |
6552 | 529 Do not start or end a documentation string with whitespace. |
530 | |
531 @item | |
532 Format the documentation string so that it fits in an Emacs window on an | |
7601
c5927c75b2b5
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6959
diff
changeset
|
533 80-column screen. It is a good idea for most lines to be no wider than |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
534 60 characters. The first line should not be wider than 67 characters |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
535 or it will look bad in the output of @code{apropos}. |
6552 | 536 |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
537 You can fill the text if that looks good. However, rather than blindly |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
538 filling the entire documentation string, you can often make it much more |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
539 readable by choosing certain line breaks with care. Use blank lines |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
540 between topics if the documentation string is long. |
6552 | 541 |
542 @item | |
543 @strong{Do not} indent subsequent lines of a documentation string so | |
544 that the text is lined up in the source code with the text of the first | |
545 line. This looks nice in the source code, but looks bizarre when users | |
546 view the documentation. Remember that the indentation before the | |
547 starting double-quote is not part of the string! | |
548 | |
549 @item | |
16671
9fa09185bca0
Explain how disabled commands' doc strings are displayed.
Richard M. Stallman <rms@gnu.org>
parents:
15198
diff
changeset
|
550 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
|
551 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
|
552 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
|
553 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
|
554 |
9fa09185bca0
Explain how disabled commands' doc strings are displayed.
Richard M. Stallman <rms@gnu.org>
parents:
15198
diff
changeset
|
555 @item |
6552 | 556 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
|
557 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
|
558 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
|
559 only in init files, then don't start the documentation string with |
6552 | 560 @samp{*}. @xref{Defining Variables}. |
561 | |
562 @item | |
563 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
|
564 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
|
565 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
|
566 @code{nil} and non-@code{nil} mean. |
6552 | 567 |
568 @item | |
40517
37a08b5afded
Document textual convention for doc strings of predicates.
Richard M. Stallman <rms@gnu.org>
parents:
38344
diff
changeset
|
569 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
|
570 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
|
571 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
|
572 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
|
573 distracting. |
37a08b5afded
Document textual convention for doc strings of predicates.
Richard M. Stallman <rms@gnu.org>
parents:
38344
diff
changeset
|
574 |
37a08b5afded
Document textual convention for doc strings of predicates.
Richard M. Stallman <rms@gnu.org>
parents:
38344
diff
changeset
|
575 @item |
6552 | 576 When a function's documentation string mentions the value of an argument |
577 of the function, use the argument name in capital letters as if it were | |
578 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
|
579 @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
|
580 actual argument name is @code{form}: |
6552 | 581 |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
582 @example |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
583 Evaluate FORM and return its value. |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
584 @end example |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
585 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
586 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
|
587 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
|
588 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
|
589 illustrate this practice: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
590 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
591 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
592 The argument TABLE should be an alist whose elements |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
593 have the form (KEY . VALUE). Here, KEY is ... |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
594 @end example |
6552 | 595 |
596 @item | |
40517
37a08b5afded
Document textual convention for doc strings of predicates.
Richard M. Stallman <rms@gnu.org>
parents:
38344
diff
changeset
|
597 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
|
598 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
|
599 ``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
|
600 |
37a08b5afded
Document textual convention for doc strings of predicates.
Richard M. Stallman <rms@gnu.org>
parents:
38344
diff
changeset
|
601 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
|
602 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
|
603 @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
|
604 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
|
605 |
37a08b5afded
Document textual convention for doc strings of predicates.
Richard M. Stallman <rms@gnu.org>
parents:
38344
diff
changeset
|
606 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
|
607 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
|
608 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
|
609 |
37a08b5afded
Document textual convention for doc strings of predicates.
Richard M. Stallman <rms@gnu.org>
parents:
38344
diff
changeset
|
610 @item |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
611 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
|
612 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
|
613 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
614 @example |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
615 The argument FOO can be either a number |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
616 \(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
|
617 @end example |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
618 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
619 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
|
620 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
|
621 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
622 @item |
6552 | 623 @iftex |
624 When a documentation string refers to a Lisp symbol, write it as it | |
625 would be printed (which usually means in lower case), with single-quotes | |
626 around it. For example: @samp{`lambda'}. There are two exceptions: | |
627 write @code{t} and @code{nil} without single-quotes. | |
628 @end iftex | |
27193 | 629 @ifnottex |
6552 | 630 When a documentation string refers to a Lisp symbol, write it as it |
631 would be printed (which usually means in lower case), with single-quotes | |
632 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
|
633 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
|
634 convention, with single-quotes for all symbols.) |
27193 | 635 @end ifnottex |
6552 | 636 |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
637 Help mode automatically creates a hyperlink when a documentation string |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
638 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
|
639 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
|
640 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
|
641 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
|
642 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
|
643 @samp{variable}, @samp{option}, @samp{function}, or @samp{command}, |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
644 immediately before the symbol name. (Case makes no difference in |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
645 recognizing these indicator words.) For example, if you write |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
646 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
647 @example |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
648 This function sets the variable `buffer-file-name'. |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
649 @end example |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
650 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
651 @noindent |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
652 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
|
653 @code{buffer-file-name}, and not to its function documentation. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
654 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
655 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
|
656 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
|
657 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
|
658 making any hyperlink. For example, |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
659 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
660 @example |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
661 If the argument KIND-OF-RESULT is the symbol `list', |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
662 this function returns a list of all the objects |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
663 that satisfy the criterion. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
664 @end example |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
665 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
666 @noindent |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
667 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
|
668 function @code{list}. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
669 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
670 To make a hyperlink to Info documentation, write the name of the Info |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
671 node in single quotes, preceded by @samp{info node} or @samp{Info |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
672 node}. The Info file name defaults to @samp{emacs}. For example, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
673 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
674 @smallexample |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
675 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
|
676 @end smallexample |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
677 |
6552 | 678 @item |
679 Don't write key sequences directly in documentation strings. Instead, | |
680 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
|
681 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
|
682 @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
|
683 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
|
684 (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
|
685 user has moved key bindings.) @xref{Keys in Documentation}. |
6552 | 686 |
687 @item | |
688 In documentation strings for a major mode, you will want to refer to the | |
689 key bindings of that mode's local map, rather than global ones. | |
690 Therefore, use the construct @samp{\\<@dots{}>} once in the | |
691 documentation string to specify which key map to use. Do this before | |
692 the first use of @samp{\\[@dots{}]}. The text inside the | |
693 @samp{\\<@dots{}>} should be the name of the variable containing the | |
694 local keymap for the major mode. | |
695 | |
696 It is not practical to use @samp{\\[@dots{}]} very many times, because | |
697 display of the documentation string will become slow. So use this to | |
698 describe the most important commands in your major mode, and then use | |
699 @samp{\\@{@dots{}@}} to display the rest of the mode's keymap. | |
700 @end itemize | |
701 | |
702 @node Comment Tips | |
703 @section Tips on Writing Comments | |
704 | |
705 We recommend these conventions for where to put comments and how to | |
706 indent them: | |
707 | |
708 @table @samp | |
709 @item ; | |
710 Comments that start with a single semicolon, @samp{;}, should all be | |
711 aligned to the same column on the right of the source code. Such | |
712 comments usually explain how the code on the same line does its job. In | |
713 Lisp mode and related modes, the @kbd{M-;} (@code{indent-for-comment}) | |
714 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
|
715 aligns such a comment if it is already present. |
6552 | 716 |
7601
c5927c75b2b5
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6959
diff
changeset
|
717 This and following examples are taken from the Emacs sources. |
6552 | 718 |
719 @smallexample | |
720 @group | |
721 (setq base-version-list ; there was a base | |
722 (assoc (substring fn 0 start-vn) ; version to which | |
723 file-version-assoc-list)) ; this looks like | |
724 ; a subversion | |
725 @end group | |
726 @end smallexample | |
727 | |
728 @item ;; | |
729 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
|
730 the same level of indentation as the code. Such comments usually |
6552 | 731 describe the purpose of the following lines or the state of the program |
732 at that point. For example: | |
733 | |
734 @smallexample | |
735 @group | |
736 (prog1 (setq auto-fill-function | |
737 @dots{} | |
738 @dots{} | |
6959
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
739 ;; update mode line |
6552 | 740 (force-mode-line-update))) |
741 @end group | |
742 @end smallexample | |
743 | |
26696
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
744 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
|
745 |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
746 @smallexample |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
747 @group |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
748 ;; This Lisp code is run in Emacs |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
749 ;; when it is to operate as a server |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
750 ;; for other processes. |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
751 @end group |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
752 @end smallexample |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
753 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
754 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
|
755 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
|
756 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
|
757 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
|
758 each argument means and how the function interprets its possible values. |
6552 | 759 |
760 @item ;;; | |
761 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
|
762 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
|
763 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
|
764 for comments that are between functions---whether to use two or three |
ef5e7bbe6f19
Current version from /gd/gnu/elisp.
Dave Love <fx@gnu.org>
parents:
26211
diff
changeset
|
765 semicolons there is a matter of style. |
6552 | 766 |
7601
c5927c75b2b5
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6959
diff
changeset
|
767 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
|
768 within a function. We use three semicolons for this precisely so that |
6959
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
769 they remain at the left margin. |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
770 |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
771 @smallexample |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
772 (defun foo (a) |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
773 ;;; This is no longer necessary. |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
774 ;;; (force-mode-line-update) |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
775 (message "Finished with %s" a)) |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
776 @end smallexample |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
777 |
6552 | 778 @item ;;;; |
779 Comments that start with four semicolons, @samp{;;;;}, should be aligned | |
780 to the left margin and are used for headings of major sections of a | |
781 program. For example: | |
782 | |
783 @smallexample | |
784 ;;;; The kill ring | |
785 @end smallexample | |
786 @end table | |
787 | |
788 @noindent | |
789 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
|
790 (@code{indent-for-comment}) and @key{TAB} (@code{lisp-indent-line}), |
6552 | 791 automatically indent comments according to these conventions, |
7601
c5927c75b2b5
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6959
diff
changeset
|
792 depending on the number of semicolons. @xref{Comments,, |
6552 | 793 Manipulating Comments, emacs, The GNU Emacs Manual}. |
794 | |
795 @node Library Headers | |
796 @section Conventional Headers for Emacs Libraries | |
797 @cindex header comments | |
798 @cindex library header comments | |
799 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
19361
diff
changeset
|
800 Emacs has conventions for using special comments in Lisp libraries |
6552 | 801 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
|
802 them. This section explains these conventions. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
803 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
804 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
|
805 distribution. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
806 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
807 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
|
808 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
|
809 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
|
810 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
|
811 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
|
812 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
|
813 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
|
814 if we haven't installed it in Emacs yet! |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
815 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
24862
diff
changeset
|
816 With that warning out of the way, on to the example: |
6552 | 817 |
818 @smallexample | |
819 @group | |
820 ;;; lisp-mnt.el --- minor mode for Emacs Lisp maintainers | |
821 | |
822 ;; Copyright (C) 1992 Free Software Foundation, Inc. | |
823 @end group | |
824 | |
825 ;; Author: Eric S. Raymond <esr@@snark.thyrsus.com> | |
826 ;; Maintainer: Eric S. Raymond <esr@@snark.thyrsus.com> | |
827 ;; Created: 14 Jul 1992 | |
828 ;; Version: 1.2 | |
829 @group | |
830 ;; Keywords: docs | |
831 | |
832 ;; This file is part of GNU Emacs. | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
833 @dots{} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
834 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
835 ;; Boston, MA 02111-1307, USA. |
6552 | 836 @end group |
837 @end smallexample | |
838 | |
839 The very first line should have this format: | |
840 | |
841 @example | |
842 ;;; @var{filename} --- @var{description} | |
843 @end example | |
844 | |
845 @noindent | |
846 The description should be complete in one line. | |
847 | |
848 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
|
849 each beginning with @samp{;; @var{header-name}:}. Here is a table of |
6552 | 850 the conventional possibilities for @var{header-name}: |
851 | |
852 @table @samp | |
853 @item Author | |
854 This line states the name and net address of at least the principal | |
855 author of the library. | |
856 | |
857 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
|
858 led by @code{;;} and a tab character, like this: |
6552 | 859 |
860 @smallexample | |
861 @group | |
862 ;; Author: Ashwin Ram <Ram-Ashwin@@cs.yale.edu> | |
6959
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
863 ;; Dave Sill <de5@@ornl.gov> |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
864 ;; Dave Brennan <brennan@@hal.com> |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
865 ;; Eric Raymond <esr@@snark.thyrsus.com> |
6552 | 866 @end group |
867 @end smallexample | |
868 | |
869 @item Maintainer | |
870 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
|
871 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
|
872 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
|
873 maintainers. The example above is mildly bogus because the maintainer |
3b19456b877a
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6552
diff
changeset
|
874 line is redundant. |
6552 | 875 |
876 The idea behind the @samp{Author} and @samp{Maintainer} lines is to make | |
877 possible a Lisp function to ``send mail to the maintainer'' without | |
878 having to mine the name out by hand. | |
879 | |
880 Be sure to surround the network address with @samp{<@dots{}>} if | |
881 you include the person's full name as well as the network address. | |
882 | |
883 @item Created | |
884 This optional line gives the original creation date of the | |
885 file. For historical interest only. | |
886 | |
887 @item Version | |
888 If you wish to record version numbers for the individual Lisp program, put | |
889 them in this line. | |
890 | |
891 @item Adapted-By | |
892 In this header line, place the name of the person who adapted the | |
893 library for installation (to make it fit the style conventions, for | |
894 example). | |
895 | |
896 @item Keywords | |
897 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
|
898 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
|
899 |
6552 | 900 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
|
901 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
|
902 can use spaces, commas, or both. |
6552 | 903 @end table |
904 | |
905 Just about every Lisp library ought to have the @samp{Author} and | |
906 @samp{Keywords} header comment lines. Use the others if they are | |
907 appropriate. You can also put in header lines with other header | |
908 names---they have no standard meanings, so they can't do any harm. | |
909 | |
910 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
|
911 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
|
912 else. Here is a table of them: |
6552 | 913 |
914 @table @samp | |
915 @item ;;; Commentary: | |
916 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
|
917 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
|
918 @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
|
919 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
|
920 context. |
6552 | 921 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
922 @item ;;; Documentation |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
923 This has been used in some files in place of @samp{;;; Commentary:}, |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
924 but @samp{;;; Commentary:} is preferred. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
925 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
926 @item ;;; Change Log: |
6552 | 927 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
|
928 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
|
929 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
|
930 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
|
931 Log:} line. @samp{History} is an alternative to @samp{Change Log}. |
6552 | 932 |
933 @item ;;; Code: | |
934 This begins the actual code of the program. | |
935 | |
936 @item ;;; @var{filename} ends here | |
937 This is the @dfn{footer line}; it appears at the very end of the file. | |
938 Its purpose is to enable people to detect truncated versions of the file | |
939 from the lack of a footer line. | |
940 @end table |