In order to access this site you need to enable JavaScript!

You are here: Reference > JavaScript > client-side > HTML DOM > objects > nodes and tags > comment

comment object

Browser support:

Indicates a non-displayed comment.

The comment tag is not rendered by the browser. It is useful to insert remarks into the source code, which can help when you edit the source code at a later time. Use the !-- tag instead.

Syntax:

Methods that return the object:

•	document.createElement ("comment")

If you want to see the HTML objects by categories, please visit this page.

HTML page for this element: comment

Possible members:

Properties

Methods

Events

Style properties

attributes

Represents a collection of attribute nodes that belong to an element.

behaviorUrns

Represents a collection of the Uniform Resource Names for all behaviors attached to an element.

canHaveChildren

Retrieves a Boolean value that indicates whether the element can contain child elements.

canHaveHTML

Retrieves a Boolean value that indicates whether the element can contain HTML formatted text.

currentStyle

Represents the computed style settings for an element.

data


9

Sets or returns the text content of a CommentNode, TextNode or comment element.

Sets or retrieves a unique identifier for the object.

innerHTML

Sets or retrieves the inner HTML content (the source code between the opening and closing tags) of an element.

isContentEditable

Returns a Boolean value that indicates whether the contents of the object are editable by the user.

isDisabled

Returns a Boolean value that indicates whether the object is disabled.

isMultiLine

Returns a Boolean value that indicates whether the contents of an element can be multiline or not.

isTextEdit

Returns a Boolean value that indicates whether the createTextRange method can be used for the element.

lang

Specifies or returns the language of the element.

length


9

Returns the number of characters within a TextNode, CommentNode or comment object.

localName

9

Returns the local part of the qualified name of the current node.

namespaceURI

9

Sets or returns the namespace URI of the current node.

nextElementSibling

9

Returns a reference to the next child element of the current element's parent.

nextSibling

Returns a reference to the next child of the current element's parent.

nodeName

Returns the name of the current node.

nodeType

Returns an integer that indicates the type of the node.

nodeValue

Sets or returns the value of the current node.

offsetParent

Returns a reference to the closest ancestor element in the DOM hierarchy from which the position of the current element is calculated.

outerHTML

Sets or retrieves the outer HTML content (the source code including the opening and closing tags) of an element.

outerText

Sets or returns the text content of an element including the text content of its descendants.

ownerDocument

Returns the document object that contains the current node.

parentElement

Returns the parent element of the object in the DOM hierarchy.

parentNode

Returns the parent element of the current node in the DOM hierarchy.

parentTextEdit

Returns the closest ancestor element of the current element in the DOM hierarchy that can be used to create a TextRange object.

previousElementSibling

9

Returns a reference to the previous child element of the current element's parent.

previousSibling

Returns a reference to the previous node of the current element's parent.

readyState

Returns a string value that represents the state of the object.

runtimeStyle

Represents the overridden style settings for an element.

scopeName

Retrieves the local name of the namespace declared for the current element.

sourceIndex

Returns the position of the current object in the all collection of the document.

style

Represents the inline style settings for an element or a CSS rule.

tagName

Returns the tag name of the current element.

tagUrn

Sets or retrieves the Uniform Resource Name (URN) of the namespace declared for the current element.

text


9

Sets or returns a string that corresponds the contents of the element.

uniqueID

Returns the unique identifier generated by the browser for the object.

addBehavior

Attaches the specified behavior to the current element.

addEventListener

9

Registers an event handler function (event listener) for the specified event on the current object.

appendData


9

Appends the specified text content to the end of the current TextNode, CommentNode or comment element.

applyElement

Inserts the specified element as a child or parent of the current element.

attachEvent

Registers an event handler function (event listener) for the specified event on the current object.

clearAttributes

Clears all attributes from the current element, except the id, name, style, value and event attributes.

cloneNode

Returns an exact copy of the current node.

compareDocumentPosition

9

Compares the placement of the specified node with the current node in the DOM hierarchy.

deleteData


9

Removes the specified part of the text content of the current TextNode, CommentNode or comment element.

detachEvent

Removes the specified event handler from the current element that was registered earlier with the attachEvent method.

dispatchEvent

9

Dispatches the specified event to the current element.

fireEvent

Initializes an event object and dispatches it to the current element.

getAdjacentText

Returns the contents of the TextNode located at the specified position relative to the current element.

getAttribute

Returns the value of the attribute with the specified name from the current element.

getAttributeNode

Returns the attribute node with the specified name from the current element.

getAttributeNodeNS

9

Returns the attribute node with the specified namespace and name from the current element.

getAttributeNS

9

Returns the value of the attribute with the specified namespace and name from the current element.

getExpression


9

Returns the dynamic expression for the specified DHTML property on the current element.

hasAttribute

8

Returns whether the current element has an attribute with the specified name or not.

hasAttributeNS

9

Returns whether the current element has an attribute with the specified namespace and name or not.

hasAttributes

8

Returns whether the current element has any attributes specified or not.

hasChildNodes

Returns whether the current node has any child nodes or not.

insertAdjacentElement

Inserts an element at the specified position relative to the current element.

insertAdjacentHTML

Inserts a HTML formatted text at the specified position relative to the current element.

insertAdjacentText

Creates a new TextNode from the specified text and inserts it at the specified position relative to the current element.

insertData


9

Inserts text content into the current TextNode, CommentNode or comment element at the specified position.

isDefaultNamespace

9

Returns whether the specified namespace URI is the default namespace in the scope of the current node.

isEqualNode

9

Returns whether the current node is equal to the specified one.

isSameNode

9

Returns whether the current node is the same node as the specified one.

isSupported

9

Returns whether the specified DOM module and version is supported by the current node.

mergeAttributes

Copies all attributes and its values from the specified element to the current element.

normalize

Puts the subtree that belongs to the current node into a 'normalized' form.

releaseCapture

Releases the mouse capture from the browser window that was previously set by the setCapture method and restores the normal event processing.

removeAttribute

Removes the attribute with the specified name from the current element.

removeAttributeNode

Removes the specified attribute node from the current element.

removeAttributeNS

9

Removes the attribute with the specified namespace and name from the current element.

removeBehavior

Removes the specified behavior from the current element.

removeEventListener

9

Removes the specified event handler from the current element that was registered earlier with the addEventListener method.

removeExpression


9

Removes the dynamic expression from the specified DHTML property on the current element.

removeNode

Removes the current element with or without its children from the document tree.

replaceData


9

Replaces the specified part of the text content of the current TextNode, CommentNode or comment element with a new text.

replaceNode

Replaces the current element with the specified element.

setAttribute

Adds an attribute with the specified name and value to the current element.

setAttributeNode

Adds the specified attribute node to the current element.

setAttributeNodeNS

9

Adds the specified attribute node to the current element.

setAttributeNS

9

Adds an attribute with the specified namespace, name and value to the current element.

setCapture

Sets the current object to capture mouse events that occur within the entire browser window.

setExpression


9

Sets a dynamic expression for the specified DHTML property on the current element.

substringData


9

Returns the part of the current element's text content from the specified position with the specified length.

swapNode

Interchanges the positions of the current element and the specified element in the document hierarchy.

Example HTML code 1:

This example illustrates the use of the comment element:

<comment>This object is a Microsoft extension to HTML.</comment>

Copy Code

Preview

Syntax Highlighter

Did you find this example helpful? yes no

Example HTML code 2:

This example shows how to get the contents of a comment element in JavaScript:

<head>
    <script type="text/javascript">
        function GetComment () {
            var comment = document.getElementById ("myComment");
            alert (comment.text);
        }
    </script>
</head>
<body>
    <button onclick="GetComment ()">Get the contents of the hidden comment</button>
    <comment id="myComment">This object is a Microsoft extension to HTML.</comment>
</body>