Variable: cider-comment-style

cider-comment-style is a customizable variable defined in cider-eval.el.

Value

line

Documentation

The style used by the eval-to-comment commands when inserting a result.

The available styles are:

  line -- a line comment (e.g. ";; => 42"). This is the default and
               honors the cider-comment-prefix, cider-comment-continued-prefix
               and cider-comment-postfix options.
  discard -- a reader discard form (e.g. "#_42"), which keeps the result as a
               navigable Clojure datum rather than comment text.
  comment -- a comment form (e.g. "(comment 42)").

The discard and comment styles ignore the cider-comment-* prefix options and use their own fixed formatting.

This variable was added, or its default value changed, in cider version 2.0.0.

Source Code

;; Defined in ~/.emacs.d/elpa/cider-20260821.817/cider-eval.el
(defcustom cider-comment-style 'line
  "The style used by the eval-to-comment commands when inserting a result.

The available styles are:

  `line'    -- a line comment (e.g. \";; => 42\").  This is the default and
               honors the `cider-comment-prefix', `cider-comment-continued-prefix'
               and `cider-comment-postfix' options.
  `discard' -- a reader discard form (e.g. \"#_42\"), which keeps the result as a
               navigable Clojure datum rather than comment text.
  `comment' -- a `comment' form (e.g. \"(comment 42)\").

The `discard' and `comment' styles ignore the `cider-comment-*' prefix options
and use their own fixed formatting."
  :type '(choice (const :tag "Line comment (;; =>)" line)
                 (const :tag "Reader discard form (#_)" discard)
                 (const :tag "Comment form (comment ...)" comment))
  :group 'cider
  :package-version '(cider . "2.0.0"))