CKEditor 生态系统文档
Search
Contribute to this guide
主页/CKEditor 5/功能

guideHTML 注释元素

默认情况下，编辑器在初始化时会过滤掉所有 HTML 注释。该 HtmlComment 功能允许开发者在文档中保留 HTML 注释，而不会将其显示给用户。

HTML 注释功能尚处于实验阶段，尚未准备好用于生产环境。

目前对 HTML 注释的支持处于基本级别 - 请参阅下面的已知问题部分。

# 演示

下面的编辑器配置为在文档内容中保留 HTML 注释。您可以使用源代码编辑功能查看文档的源代码。切换源代码编辑模式源代码编辑以查看文档源代码中存在 HTML 注释。尝试取消注释图片下方的段落。离开源代码编辑模式后，您将在可编辑区域看到此段落。

旅行带给你的宝贵经验

A lone wanderer looking at Mount Bromo volcano in Indonesia.

对多样性的欣赏

适应一种完全不同的文化可能具有挑战性。虽然在线或从书籍中了解文化也很不错，但没有什么能比得上亲身感受文化多样性。在变得更加文化包容的同时，您学会欣赏每一个差异。

# 安装

⚠️ 新的导入路径

从 42.0.0 版本 开始，我们更改了导入路径的格式。本指南使用新的、更短的格式。如果您使用的是 CKEditor 5 的旧版本，请参阅旧版设置中的包指南。

要将此功能添加到您的富文本编辑器，请安装 @ckeditor/ckeditor5-html-support 包

此包是我们开源聚合包的一部分。

npm install ckeditor5

然后将其添加到编辑器配置中

import { HtmlComment } from 'ckeditor5';

ClassicEditor
    .create( document.querySelector( '#editor' ), {
        plugins: [ HtmlComment, ... ],
    } )
    .then( ... )
    .catch( ... );

HTML 注释功能不需要任何配置。

# 已知问题

HTML 注释功能的主要问题是注释在各种情况下很容易重新定位或丢失 #10118，#10119。此外，在编辑器中复制和粘贴（或拖放）包含 HTML 注释的元素的效果也不如预期 #10127。

我们欢迎您的反馈，如果您发现任何问题，请随时在CKEditor 5 主存储库中报告。

CKEditor 5 还有其他与 HTML 编辑相关的功能，您可能需要查看

  • 源代码编辑 – 提供查看和编辑文档源代码的功能。当这两个插件配对时，用户可以获得对内容编辑的强大控制。
  • HTML 嵌入 – 允许在编辑器中嵌入任意 HTML 片段。它比 GHS 更受限制且更可控，用于任意 HTML。

# 贡献

该功能的源代码可在 GitHub 上获得：https://github.com/ckeditor/ckeditor5/tree/master/packages/ckeditor5-html-support。