unofficial mirror of help-gnu-emacs@gnu.org
 help / color / mirror / Atom feed
From: exits funnel <exitsfunnel@yahoo.com>
Subject: Re: A couple rudimentary elisp questions
Date: Tue, 2 Mar 2004 13:40:05 -0800 (PST)	[thread overview]
Message-ID: <20040302214005.64889.qmail@web40508.mail.yahoo.com> (raw)
In-Reply-To: <87smgtxqcs.fsf@thalassa.informatimago.com>

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1: Type: text/plain; charset=us-ascii, Size: 3125 bytes --]

> In emacs lisp there's no multiline comment. You can
> use
> comment-region / uncomment-region to comment several
> lines at once.
> 
> Otherwise you can use this trick: use a multi-line
> string as a
> comment, like you do for documentation strings:
> 
> (defun my-fun ()
>     " This
> is the documentation
> string of the function
> my-fun that appears 
> when you ask for the 
> function documentation
> with (describe-function 'my-fun)
> or C-h C-f my-fun RET
> "
>     (do-something)
>     " Here is a ''comment''
>       spread on several
>       lines.
>       Actually, it's not a 
>       comment, it's a string
>       that is ''evaluated''
>       in the course of this
>       function, but since
>       we don't do anything
>       with it, it's finally
>       ignored. "
>     (do-something-else)
>     (get-result))
> 
> Of course, since the strings are syntactically
> significant, you must
> take care where you put them. You can't put them
> inside function
> argument lists, or inside other data lists.  They
> eventually get
> ignored only in statement lists, inside progn and
> equivalent (and not
> in a result position!).
> 
> Perhaps a cleaner way to do it would be to defined a
> comment macro:
> 
>     (defmacro rem (&rest args))
> 
>     (defun my-fun ()
>     " This
> is the documentation
> string of the function
> my-fun that appears 
> when you ask for the 
> function documentation
> with (describe-function 'my-fun)
> or C-h C-f my-fun RET
> "
>     (do-something)
>     (rem Here we have a "comment"
>          but it is still scanned
>          and tokenized.
>          "So we may still use strings
>           and use any kind of invalid
>           token such as . . . :-)
>           But note that you must still
>           escape double-quotes such as: \"
>         ")
>     (do-something-else)
>     (get-result))
> 
> You get two advantages with this rem macro:
> 
>     1- a code walker can find your comments if you
> need to process them.
> 
>     2- since the macro generates nothing, the
> comment/strings don't
>        eventually appear in compiled code, and the
> execution  of
>        compiled code is strictly equivalent with or
> without the (rem ...)
>        (that could be not the case without the
> macro).


> It's the notation for a cons cell:
> 
>     (cons 'foo 'bar) == (foo . bar)
> 
> Lists are built on cons cells, starting from the
> empty list ():
> 
>     (cons 'foo ())             == (foo . ())        
>  == (foo)
> 
>     (cons 'bar (cons 'foo ())) == (bar . (foo . ()))
>  == (bar foo)
> 
>     (cons 'baz
>       (cons 'bar
>          (cons 'foo ()))) == (baz . (bar . (foo .
> ()))) == (baz bar foo)
> 
> 
> The value assigned to the symbol nil is (), the
> empty list, which is
> actually a special atom. 
> The empty list () is NOT a cons: (consp ()) == nil,
> (atom ()) == t.

Pascal, I just wanted to take a quick moment to thank
you for your detailed reply.  All of the information
was very helpful.  

-exits

__________________________________
Do you Yahoo!?
Yahoo! Search - Find what you’re looking for faster
http://search.yahoo.com

  reply	other threads:[~2004-03-02 21:40 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <mailman.810.1078098980.340.help-gnu-emacs@gnu.org>
2004-03-01  0:56 ` A couple rudimentary elisp questions Guldo K
2004-03-01  0:57 ` Johan Bockgård
2004-03-01  1:09   ` exits funnel
2004-03-01  2:17 ` Pascal Bourguignon
2004-03-02 21:40   ` exits funnel [this message]
     [not found] <mailman.812.1078103660.340.help-gnu-emacs@gnu.org>
2004-03-01 17:09 ` Stefan Monnier
2004-02-29 23:55 exits funnel

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20040302214005.64889.qmail@web40508.mail.yahoo.com \
    --to=exitsfunnel@yahoo.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).