Mercurial > hg > xemacs-beta

comparison man/lispref/tips.texi @ 5791:9fae6227ede5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Silence texinfo 5.2 warnings, primarily by adding next, prev, and up pointers to all nodes. See xemacs-patches message with ID <5315f7bf.sHpFD7lXYR05GH6E%james@xemacs.org>.
author Jerry James <james@xemacs.org>
date Thu, 27 Mar 2014 08:59:03 -0600
parents 99f8ebc082d9
children
comparison
equal deleted inserted replaced
5790:dcf9067f26bb 5791:9fae6227ede5
19 * Documentation Tips:: Writing readable documentation strings. 19 * Documentation Tips:: Writing readable documentation strings.
20 * Comment Tips:: Conventions for writing comments. 20 * Comment Tips:: Conventions for writing comments.
21 * Library Headers:: Standard headers for library packages. 21 * Library Headers:: Standard headers for library packages.
22 @end menu 22 @end menu
23 23
24 @node Style Tips 24 @node Style Tips, Compilation Tips, Tips, Tips
25 @section Writing Clean Lisp Programs 25 @section Writing Clean Lisp Programs
26 26
27 Here are some tips for avoiding common errors in writing Lisp code 27 Here are some tips for avoiding common errors in writing Lisp code
28 intended for widespread use: 28 intended for widespread use:
29 29
254 itself. If you have not signed papers to assign the copyright to the 254 itself. If you have not signed papers to assign the copyright to the
255 Foundation, then place your name in the copyright notice in place of the 255 Foundation, then place your name in the copyright notice in place of the
256 Foundation's name. 256 Foundation's name.
257 @end itemize 257 @end itemize
258 258
259 @node Compilation Tips 259 @node Compilation Tips, Documentation Tips, Style Tips, Tips
260 @section Tips for Making Compiled Code Fast 260 @section Tips for Making Compiled Code Fast
261 @cindex execution speed 261 @cindex execution speed
262 @cindex speedups 262 @cindex speedups
263 263
264 Here are ways of improving the execution speed of byte-compiled 264 Here are ways of improving the execution speed of byte-compiled
314 the flexibility of changing the program, don't do it unless it gives 314 the flexibility of changing the program, don't do it unless it gives
315 a noticeable speedup in something slow enough that users care about 315 a noticeable speedup in something slow enough that users care about
316 the speed. @xref{Inline Functions}. 316 the speed. @xref{Inline Functions}.
317 @end itemize 317 @end itemize
318 318
319 @node Documentation Tips 319 @node Documentation Tips, Comment Tips, Compilation Tips, Tips
320 @section Tips for Documentation Strings 320 @section Tips for Documentation Strings
321 321
322 Here are some tips for the writing of documentation strings. 322 Here are some tips for the writing of documentation strings.
323 323
324 @itemize @bullet 324 @itemize @bullet
444 display of the documentation string will become slow. So use this to 444 display of the documentation string will become slow. So use this to
445 describe the most important commands in your major mode, and then use 445 describe the most important commands in your major mode, and then use
446 @samp{\\@{@dots{}@}} to display the rest of the mode's keymap. 446 @samp{\\@{@dots{}@}} to display the rest of the mode's keymap.
447 @end itemize 447 @end itemize
448 448
449 @node Comment Tips 449 @node Comment Tips, Library Headers, Documentation Tips, Tips
450 @section Tips on Writing Comments 450 @section Tips on Writing Comments
451 451
452 We recommend these conventions for where to put comments and how to 452 We recommend these conventions for where to put comments and how to
453 indent them: 453 indent them:
454 454
534 (@code{indent-for-comment}) and @key{TAB} (@code{lisp-indent-line}) 534 (@code{indent-for-comment}) and @key{TAB} (@code{lisp-indent-line})
535 automatically indent comments according to these conventions, 535 automatically indent comments according to these conventions,
536 depending on the number of semicolons. @xref{Comments,, 536 depending on the number of semicolons. @xref{Comments,,
537 Manipulating Comments, xemacs, The XEmacs User's Manual}. 537 Manipulating Comments, xemacs, The XEmacs User's Manual}.
538 538
539 @node Library Headers 539 @node Library Headers, , Comment Tips, Tips
540 @section Conventional Headers for XEmacs Libraries 540 @section Conventional Headers for XEmacs Libraries
541 @cindex header comments 541 @cindex header comments
542 @cindex library header comments 542 @cindex library header comments
543 543
544 XEmacs has conventions for using special comments in Lisp libraries 544 XEmacs has conventions for using special comments in Lisp libraries