CEDET 
 User Tools 
  Simple Setup 
  Project Management 
  Smart Completion 
  Find References 
  Code Generation 
  UML Graphs 
  Language Support 
  Project Support 
 Developer Primers 
  Add a Language 
  Add external tool 
 Parts of CEDET 
  EDE 
  Semantic 
  SRecode 
  Cogre 
  Speedbar 
  EIEIO 
  Misc Tools 
  Documentation 
 Releases 
  1.0.1 
  1.1 
 Source Forge 
  Project 
  Mailing Lists 
   cedet-devel 
   cedet-semantic 
   cedet-eieio 
  Screenshots 
  Bzr Repository 
 More Tools 
  JDEE 
  ECB 
  CompletionUI 
 
<< Files >>

Checkdoc

Emacs Lisp Source Style Checker

Checkdoc is a utility useful for checking the style of your Emacs Lisp files. The styles examined were gleaned from the Emacs Lisp manual and logical extensions.

Currently doc strings are the most extensivly checked for style, including:


Running Checkdoc
  1. First line a complete sentence
  2. Proper user of keyboard nmumonics
  3. Proper whitespace and formatting
  4. Proper use of symbol `quoting'
  5. Proper variable names
  6. Proper function argument reference.
  7. Verb tense (for a select group of words)
  8. Spelling

Checkdoc has extended tests for rogue whitespace (at the end of lines), error text style, and comment styles. (Comment style hooks into lisp-mnt.el:lm-verify.)

Checkdoc's style checking engines are all accessible through `checkdoc-minor-mode' which provides keybindings to remind you of your stylistic errors as you write your code, and preventing long annoying sessions of checking all your documentation.

Downloading checkdoc

Checkdoc is now a part of both Emacs and XEmacs. The versions of checkdoc within GNU Emacs are more recent than those provided here.

You can download the last release I provided:

checkdoc.el-0.6.1b.gz


 
Get CEDET at SourceForge.net.
gnu Eric's homepage
Return to CEDET.
Send mail to cedet-devel to contact the developers.
Visit Siege-engine.com to see what I do in analog land.

Copyright(C) 1997,98,99,2000,01,02,03,04,05,06,07,08,09,10,11 Eric M. Ludlam
Verbatim copying and distribution is permitted in any medium, provided this notice is preserved.