《Core Java Vol.2》XML注释疑问：为何禁用隐藏命令？Processing Instructions如何用？

Great question—let’s break this down clearly, since Cay’s point gets at a core principle of XML design.

What exactly is a "hidden command" in XML comments? #

A "hidden command" here refers to sneaking machine-executable instructions into XML comments, pretending they’re just human-readable notes, while expecting an XML processor or tool to parse and act on them.

For example, someone might write something like:

<!-- IMPORT_DATA: users.csv -->
<!-- ENABLE_VALIDATION: true -->

They’re hoping their custom XML tool will scan the comments, pick up these directives, and run the associated actions—but this goes against the entire purpose of XML comments.

Why shouldn’t you put these commands in comments? #

There are three key reasons Cay emphasizes this rule:

• XML spec mandates comments are ignored: The XML standard explicitly states that all comment content must be discarded by XML processors. Relying on comments for commands means your code will be unpredictable—some tools might ignore them entirely, others might have non-standard behavior, leading to bugs that are hard to debug.
• Syntax risks: Comments use the <!-- ... --> syntax, and any occurrence of -- inside the comment will break the XML structure (e.g., <!-- RUN: --reboot --> would end the comment early, causing a parsing error). This makes comments a fragile place to put any structured command.
• Maintainability chaos: Other developers (or future you!) will see comments as explanatory text, not functional code. They might edit or delete these "commands" without realizing they’re critical to the XML’s behavior, leading to unexpected failures.

How to use Processing Instructions (PIs) instead? #

Processing Instructions are XML’s built-in, standardized way to pass instructions to XML processors—they’re designed specifically for this job.

The syntax for a PI is:

<?target-name instruction-content?>

• target-name: The name of the processor or tool that should act on the instruction (e.g., xml-stylesheet for XSLT processors).
• instruction-content: The command or parameters, usually formatted like XML attributes for easy parsing.

Examples of valid PIs: #

1. Standard PI for XSLT styling: This is a widely supported PI that tells XSLT processors to apply a stylesheet:

   <?xml-stylesheet type="text/xsl" href="user-profile.xsl"?>
   

2. Custom PI for your own tool: If you’re building a custom XML processor, you can define your own target and instructions:

   <?my-data-processor import-source="users.csv" validate="true"?>
   

   Your tool can listen for PIs with the my-data-processor target, then parse the attributes to execute the requested actions.

PIs solve all the problems of comment-based commands: they’re part of the XML spec, so processors know to handle them; their syntax is rigid and safe; and any developer reading the XML will immediately recognize them as functional instructions, not just notes.

内容的提问来源于stack exchange，提问作者Pavel