Commit cfbd1a6f authored by Richard M. Stallman's avatar Richard M. Stallman
Browse files

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

parent 55111a56
...@@ -204,11 +204,14 @@ say which functions are replaced, and how the behavior of the ...@@ -204,11 +204,14 @@ say which functions are replaced, and how the behavior of the
replacements differs from that of the originals. replacements differs from that of the originals.
@item @item
Avoid using macros that define functions and variables with names that Constructs that define a function or variable should be macros,
are constructed. It is best for maintenance when the name of the not functions, and their names should start with @samp{def}.
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 @item
@code{defun}, @code{defalias}, @code{defvar} and @code{defcustom}. 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 @item
Please keep the names of your Emacs Lisp source files to 13 characters Please keep the names of your Emacs Lisp source files to 13 characters
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment