HTML::O...:Comment(3)

📦 version 0.6.0, in alpine 3.24

💬 HTML::Object::Comment(3) — the Perl manpage, but make it group chat

okay bestie, listen — this is the HTML::Object::Comment page from User Contributed Perl Documentation, and it's literally the class for HTML comment elements. That's it, that's the whole vibe. No cap, it's a small one, so we're gonna get through it together and you're gonna understand everything. 💖

✨ NAME ✨

HTML::Object::Comment — the HTML Object Comment Element Class 👑

That's the whole name. That's the whole class. Iconic behaviour honestly.

🎀 SYNOPSIS 🎀

okay so here's how you actually use it:

use HTML::Object::Comment;
my $this = HTML::Object::Comment->new ||
    die( HTML::Object::Comment->error, "\n" );

see that? you use it, you call ->new, and if it fails you die with whatever error it's giving you plus a newline. classic Perl bestie move. 🫶

🦋 VERSION 🦋

v0.2.0

that's the version, periodt. 💅

🌸 DESCRIPTION 🌸

This module represents an HTML comment. that's literally the entire description and honestly? she said what she said. no notes. ✨

💜 INHERITANCE 💜

so here's the family tree, and it's tiny:

+-----------------------+     +-----------------------+
| HTML::Object::Element | --> | HTML::Object::Comment |
+-----------------------+     +-----------------------+

HTML::Object::Element is the parent, and HTML::Object::Comment inherits from it. one arrow, one ancestor, zero drama. 🌈

🧚 PROPERTIES 🧚

⭐ nodeValue

This returns or sets the value of the current node. ✨

okay so heads up, this is where it gets a little specific:

  • for document, element or collection → this returns undef 😭
  • for attribute, text or comment → this returns the objct value

(and yes, the original page says "objct" — we're keeping it exactly as written, don't come for me 🙈)

want the full details? the original points you here: <https://developer.mozilla.org/en-US/docs/Web/API/Node/nodeValue> 👑

🔥 METHODS 🔥

💫 as_string

Returns the HTML comment as a string. that's it, that's her job. 🎀

💫 as_xml

Returns the comment as an XML string., which is almost the same format as with as_string

(yeah there's a stray comma-period in there — that's exactly how the page says it, so we're preserving it like a museum piece 🖼️)

💫 close_seq

Set or get the string used as a close sequence. 🚪

💫 isEqualNode

Returns a boolean value which indicates whether or not two elements are of the same type and all their defining data points match. ⚖️

and like… when are two elements equal? glad you asked bestie:

Two elements are equal when they have the same type, defining characteristics (this would be their ID, number of children, and so forth), its attributes match, and so on. The specific set of data points that must match varies depending on the types of the elements.

need the deep lore? here you go: <https://developer.mozilla.org/en-US/docs/Web/API/Node/isEqualNode> 🌸

💫 nodeValue

This returns or sets the value of the current element.

(yes, it shows up again here under METHODS — different one-liner than the PROPERTIES one, and we are not merging them, bestie, the page lists both and so do we 💅)

See for more information <https://developer.mozilla.org/en-US/docs/Web/API/Node/nodeValue>

💫 open_seq

Set or get the string used as an open sequence. 🚪✨

💫 set_checksum

Read-only. 🔒

Get the element md5 checksum for the current value. 🔐

💫 value

Set or get the comment inner value, i.e. the text within, as a scalar object. 💬

👑 AUTHOR 👑

Jacques Deguest <jack@deguest.jp> — thank you for this module, king 🫶

🌈 SEE ALSO 🌈

the required reading list, and we are linking all of it because that's what she deserves:

(and ngl, seeing HTML::Object::Comment listed in its own SEE ALSO is very main character energy of her ✨)

Copyright (c) 2021 DEGUEST Pte. Ltd.

All rights reserved

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. 💖

💀 quick vibe check bestie: those license terms are doing real legal work, so treat them with respect — "same terms as Perl itself" is a real, meaningful thing, don't sleep on it.

and that's the page!! 🎉 tiny module, huge heart. this was perl v5.42.2, dated 2026-02-15, and it was rendered in the fine tradition of HTML::O...:Comment(3) — the truncated title is doing its own thing and honestly? we respect it. mwah 💋🦋💜

📦 where this page comes from