File: newcomment.el.html

This library contains functions and variables for commenting and uncommenting source code.

Prior to calling any comment-* function, you should ensure that comment-normalize-vars is first called to set up the appropriate variables; except for the comment-* commands, which call comment-normalize-vars automatically as a subroutine.

Defined variables (24)

comment-addHow many more comment chars should be inserted by ‘comment-region’.
comment-auto-fill-only-commentsNon-nil means to only auto-fill inside comments.
comment-columnColumn to indent right-margin comments to.
comment-combine-change-callsIf non-nil (the default), use ‘combine-change-calls’ around
comment-continueContinuation string to insert for multiline comments.
comment-empty-linesIf nil, ‘comment-region’ does not comment out empty lines.
comment-endString to insert to end a new comment.
comment-end-skipRegexp to match the end of a comment plus everything back to its body.
comment-fill-columnColumn to use for ‘comment-indent’. If nil, use ‘fill-column’ instead.
comment-indent-functionFunction to compute desired indentation for a comment.
comment-inline-offsetInline comments have to be preceded by at least this many spaces.
comment-insert-comment-functionFunction to insert a comment when a line doesn’t contain one.
comment-multi-lineNon-nil means ‘comment-indent-new-line’ continues comments.
comment-paddingPadding string that ‘comment-region’ puts between comment chars and text.
comment-quote-nestedNon-nil if nested comments should be quoted.
comment-quote-nested-functionFunction to quote nested comments in a region.
comment-region-functionFunction to comment a region.
comment-startString to insert to start a new comment, or nil if no comment syntax.
comment-start-skipRegexp to match the start of a comment plus everything up to its body.
comment-styleStyle to be used for ‘comment-region’.
comment-stylesComment region style definitions.
comment-use-global-stateNon-nil means that the global syntactic context is used.
comment-use-syntaxNon-nil if syntax-tables can be used instead of regexps.
uncomment-region-functionFunction to uncomment a region.

Defined functions (40)

comment-add(ARG)
comment-beginning()
comment-box(BEG END &optional ARG)
comment-choose-indent(&optional INDENT)
comment-dwim(ARG)
comment-enter-backward()
comment-forward(&optional N)
comment-indent(&optional CONTINUE)
comment-indent-default()
comment-indent-new-line(&optional SOFT)
comment-kill(ARG)
comment-line(N)
comment-make-bol-ws(LEN)
comment-make-extra-lines(CS CE CCS CCE MIN-INDENT MAX-INDENT &optional BLOCK)
comment-normalize-vars(&optional NOERROR)
comment-only-p(BEG END)
comment-or-uncomment-region(BEG END &optional ARG)
comment-padleft(STR &optional N)
comment-padright(STR &optional N)
comment-quote-nested(CS CE UNP)
comment-quote-nested-default(CS CE UNP)
comment-quote-re(STR UNP)
comment-region(BEG END &optional ARG)
comment-region-default(BEG END &optional ARG)
comment-region-default-1(BEG END &optional ARG)
comment-region-internal(BEG END CS CE &optional CCS CCE BLOCK LINES INDENT)
comment-search-backward(&optional LIMIT NOERROR)
comment-search-forward(LIMIT &optional NOERROR)
comment-set-column(ARG)
comment-string-reverse(S)
comment-string-strip(STR BEFOREP AFTERP)
comment-valid-prefix-p(PREFIX COMPOS)
comment-with-narrowing(BEG END &rest BODY)
indent-for-comment(&optional CONTINUE)
indent-new-comment-line(&optional SOFT)
kill-comment(ARG)
set-comment-column(ARG)
uncomment-region(BEG END &optional ARG)
uncomment-region-default(BEG END &optional ARG)
uncomment-region-default-1(BEG END &optional ARG)

Defined faces (0)