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