开发者社区

文档建议反馈控制台

文章/答案/技术大牛

发布

html 评论

HTML（HyperText Markup Language）评论是指在HTML代码中插入的一种注释，它不会被浏览器显示出来，但可以被开发者或其他查看源代码的人看到。HTML注释主要用于解释代码的功能、目的或提供其他开发者需要的信息。

基础概念

HTML注释的语法如下：

<!-- 这是一个HTML注释 -->

优势

提高代码可读性：通过添加注释，可以帮助其他开发者更快地理解代码的结构和功能。
调试方便：在开发过程中，可以通过注释掉某些代码块来测试其他部分的逻辑。
文档记录：注释可以用来记录代码的修改历史或重要决策。

类型

虽然HTML注释本身没有多种类型，但在实际开发中，可以根据用途分为以下几类：

解释性注释：解释代码的目的和工作方式。
警告性注释：提醒开发者注意潜在的问题或需要注意的地方。
待办事项注释：标记未来需要完成的任务或功能。

应用场景

代码解释：在复杂的代码段前添加注释，说明其功能和实现逻辑。
临时禁用代码：在调试时，可以用注释来临时禁用某些行或块代码。
版本控制辅助：在代码更新时，通过注释记录改动的原因和内容。

可能遇到的问题及解决方法

问题1：注释掉的代码仍然影响页面布局或功能

原因：有时候，即使代码被注释掉了，它可能仍然包含影响页面布局的元素（如空的<div>）或JavaScript逻辑。

解决方法：确保注释掉的代码块内没有任何有效的HTML标签或脚本，或者使用条件注释（仅适用于IE浏览器）。

问题2：过多或冗长的注释使代码难以阅读

原因：过多的注释可能会让代码显得杂乱，反而降低可读性。

解决方法：保持注释简洁明了，只解释必要的部分，并定期清理不再需要的注释。

示例代码

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Document</title>
</head>
<body>
    <!-- 这是一个简单的页面标题 -->
    <h1>Welcome to My Website</h1>

    <!-- 下面的代码块用于显示用户评论，当前被注释掉了 -->
    <!--
    <div id="comments">
        <ul>
            <li>Great site!</li>
            <li>Needs more features.</li>
        </ul>
    </div>
    -->

    <!-- JavaScript代码用于处理评论的提交 -->
    <script>
        // function submitComment() {
        //     // 提交评论的逻辑...
        // }
    </script>
</body>
</html>

总之，合理使用HTML注释可以提高代码的可维护性和团队协作效率。

页面内容是否对你有帮助？

有帮助

没帮助

相关·内容

仿网易评论盖楼 JS 实现 | html

看了些评论引用盖楼的网站，觉得网易的效果比较好，简单明了，让人看了就知道是引用评论，迟点准备自己也写个玩玩，应该能从中学到不少东西....前端部分实现如下：https://www.phpvar.com/archives/1382.html JS部分实现如下：评论列表 </

3.5K2 0

为WordPress 评论框添加HTML5 表单验证

WordPress 中最常用到的表单莫过于评论框了，但现在不少的WordPress 主题（包括WordPress官方的主题），其表单验证其实是借助javascript 甚至php来的。...因此，访客常常是要点击“提交评论”按钮，然后跳转到错误提示页面才知道哪里写的不够规范。这么来说，用户体验不怎么好。借助HTML5 的表单验证，我们可以轻松解决这个问题，让UE 更上一层楼。...HTML5新的表单特性 email url number range Date pickers (date, month, week, time, datetime, datetime-local) search...浏览器会自动验证用户是否输入了该字段，如果不输入无法提交表单； placeholder属性——可以给表单一段默认的文字，对用户进行提示，获得焦点的时候不会消失，当用户开始输入内容时会自动消失；对于WordPress 的话，评论框中需要用到...实际效果可在下面的评论框进行测试。立马高端大气上档次有木有！不过要浏览器支持html5才行，某IE 就不用考虑了。本文部分内容参考：w3school中文版；《HTML5开发实例大全》

4.6K10 0

WordPress 技巧：为评论模块增加更多 HTML 标签支持

WordPress 原生的评论模块内容，支持使用 HTML 标签来增强评论内容的格式和效果。...但是这肯定会带来一些安全隐患，特别是评论这种随便一个浏览者都可以提交数据的地方，容易产生跨站攻击（XSS），所以 WordPress 系统严格的限制了评论模块可以使用的 HTML 标签。...这些标签肯定是远远不够用的，如果是技术博客，评论往往需要包含代码，那么可能就需要添加 pre 标签的支持，如果想要评论中可以引用图片，那么需要 img 标签的支持。...本文就是来讲解如何在评论模块中增加更多 HTML 标签的支持。...WordPress 允许的标签和属性 WordPress 出于安全考虑，严格的限制了文章和评论等可编辑内容支持的 HTML 标签类型和标签的属性。

1.5K2 0

评论

基本的 HTML 知识告诉我们，在 HTML 文档中这样的代码表示一个表单： <input type="text" name="username...comment_list = post.comment_set.all() # 将文章、表单、以及文章下的评论列表作为模板变量传给 detail.html 模板，以便渲染相应数据。...我们在表单的视图函数里传递了一个 form 变量给模板，这个变量就包含了自动生成 HTML 表单的全部数据。在 detail.html 中通过 form 来自动生成表单。...删掉原来用于占位的 HTML 评论表单代码，即下面这段代码：评论内容的 HTML 代码，即如下的代码： <

3.5K6 0

WPJAM「评论增强插件」：支持评论点赞和评论置顶

：「WPJAM 评论增强」插件。...后台评论管理因为评论置顶的功能是针对单篇文章的评论才能置顶，所以我在 WordPress后台「文章」菜单下，添加了「文章评论」子菜单：在该界面，我把页面分成左右两块，左边首先显示文章列表，点击某篇文章即可显示该篇文章的评论列表...管理员添加评论另外一个比较重要的功能是：管理员可以给一些文章添加一些评论来丰富文章的内容了，操作也非常简单，在后台的文章列表，点击「添加评论」按钮：就会弹出管理员添加评论的界面：按照要求输入平路用户的昵称...前台评论展示和点赞前端界面无需更改任何代码，即可实现点赞，置顶评论的作者昵称前会显示置顶的图标，其他评论则按照点赞数排序。...评论增强支持评论点赞，评论置顶和按照点赞数排序。图片集 1. 给媒体创建个分类「图片集 | collection」 2. 图片分类限制为二级 3. 取消图片编辑入口 4. 附件页面直接图片链接。

2K4 0

django之评论系统及多级评论

comment_list = post.comment_set.all() # 将文章、表单、以及文章下的评论列表作为模板变量传给 detail.html 模板，以便渲染相应数据。...删掉原来用于占位的 HTML 评论表单代码，即下面这段代码： html += generate_comment_html(v_dic, margin_left_val) html += "" html += "" return...k, v in comment_dic.items(): html += TEMP1 % (0, k[1]) #设置向右偏移30个像素 html += generate_comment_html...(v, 30) html += "" html += '' return mark_safe(html) comment.html {% load xx

7.2K6 1

typecho 评论回复艾特评论人

typecho 在评论时默认是没有 @ 评论人的功能，可以用代码加一下。...在 functions.php 中： /* * 评论回复时 @ 评论人 */ function get_comment_at($coid) { $db = Typecho_Db::get()..."){ if (@$prow['status'] == "waiting"){ echo '（评论审核中...} else { if (@$prow['status'] == "waiting"){ echo '（评论审核中...）)'; }else{ echo ''; } } } 然后在 comments.php 中输出评论内容代码的前面加上： <?

1.3K2 0

WxComment评论组件接入评论内容安全检测

记录下如何为小程序评论组件添加内容安全检测功能最近打算为之前做的小程序增加评论功能，提交审核被拒，理由是存在信息安全风险 ? 于是就需要修改 WxComment 组件增加检测功能了。...# 修改评论组件找到 WxComment/component/WxComment/WxComment.js 文件在 bindFormSubmit 方法前追加如下方法： async checkMsg(

1.3K1 0

WPJAM「评论增强插件」支持后台添加评论

WPJAM「评论增强插件」新增后台添加评论功能，这样管理员也给一些文章添加一些评论来丰富文章的内容了，操作也非常简单，在后台的文章列表，点击「添加评论」按钮：就会弹出管理员添加评论的界面：按照要求输入平路用户的昵称...，上传头像，撰写评论内容，点击添加即可。...评论增强支持评论点赞，评论置顶和按照点赞数排序。图片集 1. 给媒体创建个分类「图片集 | collection」 2. 图片分类限制为二级 3. 取消图片编辑入口 4. 附件页面直接图片链接。...外部链接将文章或评论中的外部链接加上安全提示的中间页。让用户确认之后再跳转，并还支持添加 nofollow rel 属性。话题标签文章中插入 #话题标签#。

1.3K2 0

再说评论

前几天把这个主要的博客的评论系统切换为 Disqus 了。用的是 DisqusJS 的代理。巧了，DisqusJS 在几天之后发布了 3.0.0 的更新。...在追求极致速度的同时，却换上 Disqus 如此臃肿的评论系统。简直离经叛道？其实原因很简单：首先，Twikoo 和 Waline 都不再轻量了，至少不是我想要的那种轻。...毕竟生活中不止维护评论系统这一件事，所以基本上会忘记上次更新部署时做了些什么。还如上文所述，有些更新对我来说也是可有可无的。 Disqus Disqus 是不是最优解？不是。...其实现在独立博客盛景不再，要不要评论系统又有什么关系呢。

5781 0

评论框加上勾勾防止垃圾评论-emlog

emlog博客程序是开源的，因为是开源的，所以网上有很多人会水回复，这个时候你就需要一个防水机制了，当然官网插件也能实现此功能，喜欢自己动手的可以加上一下，加的地方就放到发表评论的附近即可，下面是代码...="checkbox" value=9 id="sheli" name="sheli" required="required" autocomplete="on" required title="发表评论确认框...：请勾选我再发表评论！"...> 请勾选我再发表评论！

7594 0

博客评论网易云跟帖评论提醒功能

多说官方宣布 17 年 6 月 1 号停止维护，一个优秀的评论系统从此倒下了，令人唏嘘不已，还是要感谢多说团队多年的付出。眼下留给博主们的选择也就畅言和网易云跟帖了。...之前多说收到评论会在博客的右上角提示，云跟帖就没有这个功能，而且也不会收到邮件，这样就不能即时的处理评论。好在提供了收到评论的回调功能，所以我们自己来实现发送邮件的功能。...数据回推在获取代码里面有个优化设置功能，需要我们自己设置接口来接受评论推送。以下邮件评论提示由 php 来实现。...server_name xxxx.xxx.xxx; root /var/www/comment; index index.php index.html...php header("Content-type: text/html; charset=utf-8"); date_default_timezone_set("Asia/Shanghai"); /*

8682 0

Typecho直接关闭评论与隐藏之前评论

众所周知的原因这个功能是不允许开放的我这模板无开关来处理故手动解决：外观→编辑当前外观→post.php Ctrl+F 找到:<?php $this->...

1.4K2 0

实现评论显示操作系统和评论来源

Android · '; } else { $os = 'Linux · '; } echo $os; } comments.php 中找到合适位置（比如评论作者的后面

5983 0

WordPress 代码屏蔽英文垃圾评论和评论链接

做 wordpress 博客时间长了，总有发帖软件来骚扰，时不时的给你发一组 4 个全英文评论，而且专门挑一篇文章评论。虽然启用了评论审核机制，但是手机总响起垃圾评论提示也让魏艾斯博客很烦。...对于这种现象，有两种解决思路：一个是安装评论过滤插件；另一个是用代码实现。 ? 类似上面这种全英文评论太多了，必须要想办法能在发评论之前就给他过滤掉。...：SI CAPTCHA Anti-Spam 使用验证码过滤评论也是一种不错的方法，但是不太利于用户体验。...评论滑动解锁插件：myQaptcha 我们想既达到目的又不要增加服务器负担。所以使用了常见的代码形式。...add_filter(‘preprocess_comment’, ‘wp_comment_post’); 将两处代码添加到当前主题 functions.php 最后面，可以在一定程度上过滤到大部分全英文垃圾评论和评论中的链接

1.3K2 0

评论的革新?

在最近的Real-Time CrunchUp 2009上，通过自己的产品JS-Kit（已经安装在世界上60万个网站上），Khris Loux（世界上最大的评论服务提供商之一的CEO）宣布了传统评论渠道的死亡...，指出现在我们需要找到一些传统社交网络之外的评论渠道。...同时Loux介绍了自己的新产品“Echo”，通过在自己网站上添加一小段JavaScript代码，可以将自己的站点和社交媒体和博客上的评论整合到一起，这就意味着网站的任何改动都可以通过Twitter、Flickr...通过这个工具，可以整合自己的多个站点中的评论，不过目前提供的免费版本功能还比较少，如果想要强大的功能，就要付费，俨然是SaaS呀。如果需要了解更多，可以访问 http://js-kit.com/。

3601 0

Django评论库

评论的功能打算用Django的评论库，添加引用却报错。查了一下，Django原本会自带一个评论库组件，而从1.6版本以后就没有自带了，需要自己安装。...接着，修改前端页面显示评论列表和评论提交表单。...虽然现在可以提交评论了，但提交评论之后会跳转到一个很简陋的页面。接下来用ajax写评论提交事件避免避免跳转到独立的评论页面，修正时间戳等Bug。...url: "{% comment_form_target %}", cache: false, dataType: "html...", success: function(html, textStatus) { window.location.reload()

1.1K2 1

twikoo仿段落评论，实现快速评论功能

我想了一下，下载了个番茄小说发现，他们都是按照每一行的内容分别进行评论的，Hexo可以实现类似于每一段落一个Url，也就是#[段落名]的格式，但是Twikoo并不能将这些段落分开，而且本来评论就很少了，...所以我想是否可以利用我的说说页面中的，点击评论按钮后后会在评论区添加一个：> + “文本”，从而实现类似引用的功能，那么也就实现了仿段落评论，同时所有的评论都会在评论区显示，避免了因为都在段落评论而导致主评论区没人的尴尬局面...解决好友imsyy提出的弹窗中再次点击打开弹窗会导致无法关闭的问题:点击跳转解决好友imsyy提出的弹窗中点击刷新按钮会退出的问题:点击跳转欢迎测试：请选中你想评论的段落并右键，点击：“评论选中段落...妥协方案下面我们需要实现该功能，刚开始我选择的时使用和说说页面类似的效果，当点击评论后，找到评论区输入框，将选中文字放到输入框中，进行类似于回复段落的效果，但是由于我设置的懒加载，当评论区没有滚入到页面视野内时不会自动加载...，但是因为他的评论区是只引入了一个twikoo，而我的评论区是双评论（其实屁用没有，不过当摆设倒是很高大上），导致他的样式和主题加载出来的有些不同，这里我没有记录截图，现在回退回去也有点麻烦，所以我就放一张正常的

2492 0

Disqus评论框改造工程-最近评论的实现

最近从多说迁移到了 Disqus，确实老东家做的插件会好得多，唯一的麻烦就是需要一些步骤才能看到评论框。大多功能都还凑合。唯一不满意的就是 CSS 风格。...本来也没多在意，也就一个 Disqus 的 Logo 放在那儿还看得过去，今天试着用他们 Advanced Usage 里面加了个最近评论框，同样也是 Iframe，不过各种padding加起来之后丑得不行...是时候研究一下 Disqus 的 API 了毕竟是最大的三方评论供应商，他们的 API 及其详细。1....一章内介绍了如何进行请求，实际上就是告诉你记得把 Key 传过去从Documents 页面找到我们需要的 call，也就是Forums/listPosts 注意还有其他的listPosts的需求，当前我们使用的是全站评论.../评论内容，甚至一同返回了纯文本和富文本两种内容，最后将返回的数据进行渲染一下： $.ajax({ url: 'https://disqus.com/api/3.0/forums

5233 0

纯代码实现WP评论添加@评论者功能

对于使用WordPress默认评论框的同学来说，常常会遇到这样一个问题，就是当我们回复评论者消息的时候偶尔会搞不清楚到底是回复的谁，当然我们可以通过嵌套评论来区分不同的话题，但是当大家一块参与话题互相讨论的时候还是会分不清谁回复的谁...，这时候我们就可以通过@评论者来告诉对方我是在和你交流了。...将@信息写入数据库//添加@评论者功能function qgg_comment_add_at( $commentdata ) { if( $commentdata[\'comment_parent\'...return $commentdata;}add_action( \'preprocess_comment\' , \'qgg_comment_add_at\', 20);不将@信息写入数据库//添加@评论者功能

2823 0

点击加载更多

扫码

添加站长进交流群

领取专属 10元无门槛券

手把手带您无忧上云

扫码加入开发者社群

相关资讯

热门标签

活动推荐

运营活动

活动名称

广告关闭