GNU Info

(elisp)Tips

---

Next: GNU Emacs Internals Prev: GPL Up: Top

---

Enter node , (file) or (file)node

Tips and Conventions
********************

   This chapter describes no additional features of Emacs Lisp.  Instead
it gives advice on making effective use of the features described in the
previous chapters, and describes conventions Emacs Lisp programmers
should follow.

   You can automatically check some of the conventions described below
by running the command `M-x checkdoc RET' when visiting a Lisp file.
It cannot check all of the conventions, and not all the warnings it
gives necessarily correspond to problems, but it is worth examining them
all.

Coding Conventions

Conventions for clean and robust programs.

Compilation Tips

Making compiled code run fast.

Documentation Tips

Writing readable documentation strings.

Comment Tips

Conventions for writing comments.

Library Headers

Standard headers for library packages.