matlab.io.xml.dom.Comment 类

命名空间: matlab.io.xml.dom

XML 文档中的注释

自 R2021a 起

描述

mlreportgen.io.xml.dom.Comment 类的一个对象，表示 XML 文档中的注释。

matlab.io.xml.dom.Comment 类是一个 handle 类。

类属性

`ConstructOnLoad`	`true`
`HandleCompatible`	`true`

有关类属性的信息，请参阅类属性。

创建对象

使用 matlab.io.xml.dom.Document 对象的 createComment 方法创建 matlab.io.xml.dom.Comment 对象。

属性

全部展开

`Length` — 注释中的字符数
双精度值

注释中的字符数，指定为双精度值。

属性：

`GetAccess`	`public`
`SetAccess`	`immutable`
`Transient`	`true`
`NonCopyable`	`true`

`TextContent` — 注释的文本内容
字符向量

注释的文本内容，指定为字符向量。

属性：

`GetAccess`	`public`
`SetAccess`	`immutable`
`Transient`	`true`
`NonCopyable`	`true`

方法

全部展开

公共方法

`appendData`	`appendData(thisComment,characters)` 在此注释的字符数据末尾追加字符。以字符向量或字符串标量形式指定 `characters`。
`cloneNode`	`copy = cloneNode(thisComment,deep)` 创建此注释的副本并返回该副本。如果 `deep` 为 true，则该副本为深拷贝。如果 `deep` 为 `false`，则该副本为浅拷贝。
`compareDocumentPosition`	`posEnum = compareDocumentPosition(thisComment,otherNode)` 返回双精度值，该值对拥有 `thisComment` 的文档中 `otherNode` 相对于 `thisComment` 的位置进行编码。要解码返回的值 `posEnum`，请使用 MATLAB 表达式 `bitor(posEnum,POSITION_ENUM) == posEnum`，其中 `POSITION_ENUM` 是以下 `Comment` 方法之一： DOCUMENT_POSITION_FOLLOWING - 另一个节点跟在此注释节点之后。 DOCUMENT_POSITION_PRECEDING - 另一个节点在此注释节点之前。 DOCUMENT_POSITION_CONTAINED_BY - 此注释节点包含另一个节点，后者的位置在此节点之后。 DOCUMENT_POSITION_CONTAINS - 另一个节点包含此注释节点，前者的位置在此节点之前。 DOCUMENT_POSITION_DISCONNECTED - 两个节点彼此不相连。例如： import matlab.io.xml.dom.* d = Document("root"); root = getDocumentElement(d); comment = createComment(d,"Example of a comment"); appendChild(root,comment); pos = compareDocumentPosition(comment,root); if bitor(pos,comment.DOCUMENT_POSITION_CONTAINS)... == pos disp("root contains comment"); else disp("root does not contain comment"); end
`deleteData`	`deleteData(thisComment,offset,count)` 从此注释的文本中删除某字符范围。`offset` 参量是要删除的第一个字符的索引（从 0 开始），指定为整数。`count` 参量是要删除的字符数，指定为整数。
`getBaseURI`	`uri = getBaseURI(thisComment)` 以字符向量形式返回此注释的基本 URI。注释的基本 URI 是拥有该注释的文档的 URI。
`getData`	`str = getData(thisComment)` 以字符向量形式返回此注释中的字符数据。
`getLength`	`count = getLength(thisComment)` 以双精度值形式返回此注释中的字符数。
`getNextSibling`	`sibling = getNextSibling(thisComment)` 返回此注释节点的父级的子列表中跟在此注释后面的节点。
`getNodeName`	`name = getNodeName(thisComment)` 返回 `'#comment'`。
`getNodeTypeName`	`name = getNodeTypeName(thisComment)` 返回 `'COMMENT_NODE'`。
`getNodeValue`	`value = getNodeValue(thisComment)` 以字符向量形式返回此注释的内容。
`getOwnerDocument`	`doc = getOwnerDocument(thisComment)` 返回拥有此注释的文档。所有者文档是创建或导入此注释的文档。
`getParentNode`	`parent = getParentNode(thisComment)` 返回此注释的父级。如果此注释没有父级，此方法将返回空节点。
`getPreviousSibling`	`sibling = getPreviousSibling(thisComment)` 返回此注释的父级的子列表中位于此注释之前的节点。
`getTextContent`	`text = getTextContent(thisComment)` 以字符向量形式返回此注释中的字符数据。
`insertData`	`insertData(thisComment,index,data)` 在从 0 开始的索引参量指定的位置插入字符数据。以字符向量或字符串标量形式指定 `data`。
`isEqualNode`	如果 `otherNode` 指定的节点是注释节点，并且具有与 `thisComment` 相同的文本内容，则 `tf = isEqualNode(thisComment,otherNode)` 返回 `true`。此方法测试节点的相等性，而不测试节点是否为同一对象的句柄。要测试相同性，请使用 `isSameNode` 方法。相同的节点也会相等，但相等的节点未必相同。在测试文档的相等性之前请先对它们进行标准化，因为标准化会影响相等性。
`isSameNode`	如果 `otherNode` 与 `thisComment` 是同一个节点，则 `tf = isSameNode(thisComment,otherNode)` 返回 `true`。
`replaceData`	`replaceData(thisComment,index,count,data)` 用 `data` 指定的字符替换此注释节点的文本内容中 `count` 指定的字符数，从 `index`（从 0 开始）指定的位置开始。将 `index` 和 `count` 指定为整数。以字符向量或字符串标量形式指定 `data`。
`setData`	`setData(thisComment,data)` 用 `data` 指定的文本替换此注释节点的当前内容。以字符向量或字符串标量形式指定 `data`。
`setNodeValue`	`setNodeValue(thisComment,value)` 将此注释节点的文本内容设置为 `value` 指定的文本。以字符向量或字符串标量形式指定 `value`。
`setTextContent`	`setTextContent(thisComment,textContent)` 将此注释节点中的文本内容设置为 `textContent` 指定的文本。以字符向量或字符串标量形式指定 `textContent`。
`splitText`	`newNode = splitText(thisComment,index)` 将此注释节点在指定的从 0 开始的索引处拆分为两个注释节点，并返回新的注释节点。拆分后，原始注释节点包含该索引之前的原始文本。新节点包含从该索引开始的原始文本。如果索引等于原始文本的长度，则新节点为空。如果此注释节点有父级，则该方法会在父节点中此注释节点的后面插入新注释节点。
`substringData`	`substringData(thisComment,index,count)` 返回由 `index` 和 `count` 指定的字符。Index 是要返回的第一个字符的的位置（从 0 开始），`count` 是要返回的字符数。将 `index` 和 `count` 指定为整数。

示例

全部折叠

向文档添加注释

打开实时脚本

此示例向表示一周中星期几的 XML 文档的根节点添加注释。

使用名为 weekdays 的根元素创建 matlab.io.xml.dom.Document 对象。

import matlab.io.xml.dom.*
doc = Document("weekdays");
docRootNode = getDocumentElement(doc);

使用 Document 对象的 createComment 方法创建注释。将该注释追加到根元素。

appendChild(docRootNode,createComment(doc,"days of the week except Saturday and Sunday"));

对于一周中的每个工作日，即从星期一到星期五，创建一个名为 day 的元素，并将该天的名称追加到 day 元素中。将 day 元素追加到根元素。

weekdays = ["Mon" "Tue" "Wed" "Thu" "Fri"];
for i=1:5
    dayElement = createElement(doc,"day");
    appendChild(dayElement,createTextNode(doc,weekdays(i)));
    appendChild(docRootNode,dayElement);
end

将文档写入文件 weekdays.xml；

xmlFileName = "weekdays.xml";
writer = matlab.io.xml.dom.DOMWriter;
writer.Configuration.FormatPrettyPrint = true;
writeToFile(writer,doc,xmlFileName);

显示文件内容。

type weekdays.xml;

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<weekdays>
  <!--days of the week except Saturday and Sunday-->
  <day>Mon</day>
  <day>Tue</day>
  <day>Wed</day>
  <day>Thu</day>
  <day>Fri</day>
</weekdays>

注释  紧跟在根元素 weekdays 的开始标记之后。

版本历史记录

在 R2021a 中推出

另请参阅

matlab.io.xml.dom.Document | matlab.io.xml.dom.Element | matlab.io.xml.dom.Text