unofficial mirror of help-gnu-emacs@gnu.org
 help / color / mirror / Atom feed
From: Christopher Dimech <dimech@gmx.com>
To: Stefan Monnier <monnier@iro.umontreal.ca>
Cc: help-gnu-emacs@gnu.org
Subject: Re: ELisp Multiline Comments
Date: Sat, 10 Oct 2020 18:07:06 +0200	[thread overview]
Message-ID: <trinity-861780f8-b1f7-4c61-b471-568444dab73a-1602346026228@3c-app-mailcom-bs14> (raw)
In-Reply-To: <jwvo8lagn5m.fsf-monnier+emacs@gnu.org>

   Have tried using the following for writing multiline comments, but has
   worked.

   (defmacro multic (&rest _) nil)

   ;;; gungadin-frame.el --- Customisations for Emacs Frame
   ( multic
   * Copyright and License
   ;;;;
   ====================================================================
   ;;;; Copyright and License
   ;;;;
   ====================================================================
     ___            _    _
    / __|_ __ _ _  | |  (_)__
   | (__| '_ \ '_| | |__| / _|
    \___| .__/_|   |____|_\__|
        |_|
   )
   ;; Copyright 2017 Christopher Dimech
   ;; GNU Affero General Public License, Version 3 or any later version





   Sent: Saturday, October 10, 2020 at 4:46 PM
   From: "Stefan Monnier" <monnier@iro.umontreal.ca>
   To: help-gnu-emacs@gnu.org
   Subject: Re: ELisp Multiline Comments
   > I need to use Multiline Comments in my Elisp Codes so I can insert
   > Org-Mode Commands,
   > and read you can use
   >
   > #|
   > Multiline Comment
   > |#
   >
   > What are the options
   ELisp does not support multiline comments.
   You have two options:
   - Use `;;` and make sure to either ignore them or strip them when using
   the
   comments's content:
   ;; Multiline
   ;; Comment
   - Use unused arguments, e.g.:
   (defmacro multiline-comment (&rest _) nil)
   ...
   (multiline-comment
   Multiline
   Comment
   )
   and then make sure you use those uses of `multiline-comment` only
   occur where an ELisp expression is expected (e.g. not within the
   arglist of a function) and make sure the text of those multiline
   comments corresponds to a valid read syntax of some ELisp data
   (e.g. properly matched parentheses and double quotes (but without
   counting those parens that occur after a semi-colon), no single quote
   just before an open paren, ...).
   I'd go with the first option.
   Stefan


  parent reply	other threads:[~2020-10-10 16:07 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-10-10  9:13 ELisp Multiline Comments Christopher Dimech
2020-10-10 14:46 ` Stefan Monnier
2020-10-10 14:49   ` Stefan Monnier
2020-10-10 16:07   ` Christopher Dimech [this message]
2020-10-10 16:11     ` Christopher Dimech

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=trinity-861780f8-b1f7-4c61-b471-568444dab73a-1602346026228@3c-app-mailcom-bs14 \
    --to=dimech@gmx.com \
    --cc=help-gnu-emacs@gnu.org \
    --cc=monnier@iro.umontreal.ca \
    /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).