Variable: org-babel-tangle-comment-format-beg

org-babel-tangle-comment-format-beg is a customizable variable defined in ob-tangle.el.gz.

Value

"[[%link][%source-name]]"

Documentation

Format of inserted comments in tangled code files.

The following format strings can be used to insert special information into the output using org-fill-template.
%start-line --- the line number at the start of the code block
%file --------- the file from which the code block was tangled
%link --------- Org style link to the code block
%source-name -- name of the code block

Upon insertion the formatted comment will be commented out, and followed by a newline. To inhibit this post-insertion processing set the org-babel-tangle-uncomment-comments variable to a non-nil value.

Whether or not comments are inserted during tangling is controlled by the :comments header argument.

This variable was added, or its default value changed, in Emacs 24.1.

Source Code

;; Defined in /usr/src/emacs/lisp/org/ob-tangle.el.gz
(defcustom org-babel-tangle-comment-format-beg "[[%link][%source-name]]"
  "Format of inserted comments in tangled code files.
The following format strings can be used to insert special
information into the output using `org-fill-template'.
%start-line --- the line number at the start of the code block
%file --------- the file from which the code block was tangled
%link --------- Org style link to the code block
%source-name -- name of the code block

Upon insertion the formatted comment will be commented out, and
followed by a newline.  To inhibit this post-insertion processing
set the `org-babel-tangle-uncomment-comments' variable to a
non-nil value.

Whether or not comments are inserted during tangling is
controlled by the :comments header argument."
  :group 'org-babel-tangle
  :version "24.1"
  :type 'string)