diff options
| author | Richard M. Stallman | 2006-06-16 15:22:59 +0000 |
|---|---|---|
| committer | Richard M. Stallman | 2006-06-16 15:22:59 +0000 |
| commit | cfbd1a6f5587f013da7c891b904bf19dd8390878 (patch) | |
| tree | 0be5546cc57c175fcd0121dbb0ca6fe1847ef1ed /lispref | |
| parent | 55111a5638acea8b38cca671af7bbc2d47dbff52 (diff) | |
| download | emacs-cfbd1a6f5587f013da7c891b904bf19dd8390878.tar.gz emacs-cfbd1a6f5587f013da7c891b904bf19dd8390878.zip | |
(Coding Conventions): Better explain conventions for definition constructs.
Diffstat (limited to 'lispref')
| -rw-r--r-- | lispref/tips.texi | 13 |
1 files changed, 8 insertions, 5 deletions
diff --git a/lispref/tips.texi b/lispref/tips.texi index 6ad1c166e5b..37461398473 100644 --- a/lispref/tips.texi +++ b/lispref/tips.texi | |||
| @@ -204,11 +204,14 @@ say which functions are replaced, and how the behavior of the | |||
| 204 | replacements differs from that of the originals. | 204 | replacements differs from that of the originals. |
| 205 | 205 | ||
| 206 | @item | 206 | @item |
| 207 | Avoid using macros that define functions and variables with names that | 207 | Constructs that define a function or variable should be macros, |
| 208 | are constructed. It is best for maintenance when the name of the | 208 | not functions, and their names should start with @samp{def}. |
| 209 | function or variable being defined is given explicitly in the source | 209 | |
| 210 | code, as the second element of the list---as it is when you use | 210 | @item |
| 211 | @code{defun}, @code{defalias}, @code{defvar} and @code{defcustom}. | 211 | Macros that define a functions or variables should take the name to be |
| 212 | defined as the first argument. That will help various tools find the | ||
| 213 | definition automatically. Avoid constructing the names in the macro | ||
| 214 | itself, since that would confuse these tools. | ||
| 212 | 215 | ||
| 213 | @item | 216 | @item |
| 214 | Please keep the names of your Emacs Lisp source files to 13 characters | 217 | Please keep the names of your Emacs Lisp source files to 13 characters |