procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

(Coding Conventions): Better explain conventions for definition constructs.

Browse source
This commit is contained in:
Richard M. Stallman 2006-06-16 15:22:59 +00:00
parent 55111a5638
commit cfbd1a6f55
1 changed files with 8 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
lispref/tips.texi
View file

@ -204,11 +204,14 @@ say which functions are replaced, and how the behavior of the
replacements differs from that of the originals.
@item
Avoid using macros that define functions and variables with names that
are constructed. It is best for maintenance when the name of the
function or variable being defined is given explicitly in the source
code, as the second element of the list---as it is when you use
@code{defun}, @code{defalias}, @code{defvar} and @code{defcustom}.
Constructs that define a function or variable should be macros,
not functions, and their names should start with @samp{def}.
@item
Macros that define a functions or variables should take the name to be
defined as the first argument. That will help various tools find the
definition automatically. Avoid constructing the names in the macro
itself, since that would confuse these tools.
@item
Please keep the names of your Emacs Lisp source files to 13 characters