WordPress建站主题实践:代码注释

技术文档181,262阅读模式

WordPress建站主题实践:代码注释

wordpress主题主要包含HTML、CSS、php、JavaScript四种代码。今天飞牛在修改wordpresss主题的时候就遇到问题,不想让某一段代码输出,但是又不想删除,方便后悔了可以继续使用,这时候就需要用到注释。网上搜索并实践,将知识记录下来。文章源自飞牛士 FeiNews-https://www.feinews.com/experience/1298.html

HTML注释

注意:html 注释标签和其它语言的注释不一样。比如:JavaScript、php等语言都有单行注释和多行注释,但是 html 注释标签只有一个,单行和多行都是使用同一个标签来注释。文章源自飞牛士 FeiNews-https://www.feinews.com/experience/1298.html

<!-- 这里是注释的内容 -->
<!-- 此刻不显示图片:
<img border="0" src="/i/tulip_ballade.jpg" alt="Tulip">
-->

注意: 注释中可以直接使用回车换行。文章源自飞牛士 FeiNews-https://www.feinews.com/experience/1298.html

并且我们习惯用注释的标签把HTML代码包裹起来。如:文章源自飞牛士 FeiNews-https://www.feinews.com/experience/1298.html

<!-- xx部分 开始 -->
    这里放你xx部分的HTML代码
<!-- xx部分 结束 -->

 文章源自飞牛士 FeiNews-https://www.feinews.com/experience/1298.html

HTML注释的注意事项:文章源自飞牛士 FeiNews-https://www.feinews.com/experience/1298.html

  1. HTML注释不支持嵌套。
  2. HTML注释不能写在HTML标签中

建议:注释的内容两边留个空格
[c-alert type="warning"]提示:单行注释中使用最广泛是使用双斜杠“//”来定义注释。[/c-alert]文章源自飞牛士 FeiNews-https://www.feinews.com/experience/1298.html

不推荐以下这种不留空格:文章源自飞牛士 FeiNews-https://www.feinews.com/experience/1298.html

<!--This section is non-normative-->

 文章源自飞牛士 FeiNews-https://www.feinews.com/experience/1298.html

多行注释:范例来源于wordpress 2020主题:文章源自飞牛士 FeiNews-https://www.feinews.com/experience/1298.html

/**
 * The main template file
 *
 * This is the most generic template file in a WordPress theme
 * and one of the two required files for a theme (the other being style.css).
 * It is used to display a page when nothing more specific matches a query.
 * E.g., it puts together the home page when no home.php file exists.
 *
 * @link https://developer.wordpress.org/themes/basics/template-hierarchy/
 *
 * @package WordPress
 * @subpackage Twenty_Twenty
 * @since 1.0.0
 */

PHP、JS、CSS

单行注释

单行注释有两种方式,分别是使用“#”和反斜杠“//”。文章源自飞牛士 FeiNews-https://www.feinews.com/experience/1298.html

// 这是单行注释
# 这也是单行注释

[c-alert type="warning"]提示:单行注释中使用最广泛是使用双斜杠“//”来定义注释。[/c-alert]文章源自飞牛士 FeiNews-https://www.feinews.com/experience/1298.html

多行注释块

/*
  这是多行注释块
  它横跨了
  多行
*/

[c-alert type="warning"]提示:多行注释不能相互嵌套使用。[/c-alert]文章源自飞牛士 FeiNews-https://www.feinews.com/experience/1298.html

当然,这种方式也可以作为单行注释使用文章源自飞牛士 FeiNews-https://www.feinews.com/experience/1298.html

/* echo "PHP 注释"; */
文章源自飞牛士 FeiNews-https://www.feinews.com/experience/1298.html文章源自飞牛士 FeiNews-https://www.feinews.com/experience/1298.html
评论  18  访客  11  作者  7
    • 林羽凡
      林羽凡 5

      你首页这样的布局排版就好多了,进来首页一眼就能看出来,哪些是最近更新的。下面回复@好扎眼,哈哈哈哈

        • 飞牛
          飞牛

          @ 林羽凡 嗯,目前感觉还不错的,就怕过段时间又换了个心水又换主题哈哈。
          @这个提示比较明显,我觉得还行。

            • 林羽凡
              林羽凡 5

              @ 飞牛 最新提交的评论不是应该排到最前面的么

                • 飞牛
                  飞牛

                  @ 林羽凡 嗯,改过来了,一开始是想着最早留言就应该排前面。[f=tiaopi]

                    • 林羽凡
                      林羽凡 5

                      @ 飞牛 你速度真快,哈哈哈哈,不过邮件的表情没解析。[f=tiaopi] f=tiaopi

                        • 飞牛
                          飞牛

                          @ 林羽凡 个人比较追求效率,不马上去做的话事情越拖拖多,越多越拖。

                            • 林羽凡
                              林羽凡 5

                              @ 飞牛 越拖越不想做,积着多了,自己看到要做的事,就心累。

                  • 孤斗-伍子蛇
                    孤斗-伍子蛇 2

                    小tip:其实主流的编辑器,不管任何语言,“command(ctrl) + / ”就可以注释,它会选择正确的方式进行注释,就和 ctrl + s是保存一样通用

                    • 王麻子
                      王麻子 3

                      资深的一定不是菜鸟,资深菜鸟那一定是自谦的。PS:简约的主题能给你带来沉浸式的阅读体验,但是,不百花看过,又焉知此味[f=touxiao]

                        • 飞牛
                          飞牛

                          @ 王麻子 翻不起浪花所以自诩菜鸟,而飞牛就是吹了十几年风却也没有任何浪花所以自评资深菜鸟。
                          博客程序接触不多,特别是wordpress,早些年接触了一阵子,没有深入,所以博客的装维算是一次学习经历。风格随着心情而变,百花皆尝,择适而优,潮有起落,变化万千。

                        • 夏目贵志
                          夏目贵志 5

                          换主题啦?

                            • 飞牛
                              飞牛

                              @ 夏目贵志 是啊,换了前几天推荐的免费主题,原来的主题太花了,试试这个。[f=shengli]

                                • 夏目贵志
                                  夏目贵志 5

                                  @ 飞牛 这个 就是 简约,方便看最新的文章 哈哈

                                  我好像没收到回复通知?是不是还没设置?

                                    • 飞牛
                                      飞牛

                                      @ 夏目贵志 嗯,是够简约的,不过还是有些不足。
                                      邮件通知之前没设置,不知道现在设置了没问题了吧?

                              匿名

                              发表评论

                              匿名网友 填写信息

                              :?: :razz: :sad: :evil: :!: :smile: :oops: :grin: :eek: :shock: :???: :cool: :lol: :mad: :twisted: :roll: :wink: :idea: :arrow: :neutral: :cry: :mrgreen:

                              确定