回顾之前知识: 注释

Posted lszw

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了回顾之前知识: 注释相关的知识,希望对你有一定的参考价值。

单行注释怎么写,多行注释怎么写?

html 注释标签

您能够通过如下语法向 HTML 源代码添加注释:

实例

<!-- 在此处写注释 -->

注释:在开始标签中有一个惊叹号,但是结束标签中没有。

浏览器不会显示注释,但是能够帮助记录您的 HTML 文档。

您可以利用注释在 HTML 中放置通知和提醒信息:

 

CSS 注释标签

 CSS 中增加注释很简单,所有被放在/**/分隔符之间的文本信息都被称为注释。

CSS 只有一种注释,不管是多行注释还是单行注释,都必须以/*开始、以*/结束,中间加入注释内容。

【示例1】注释放在样式表之外。

  1. /*定义网页的头部样式*/
  2. .head width: 960px;
  3. /*定义网页的底部样式*/
  4. .footer width:960px;


【示例2】注释放在样式表内部。

  1. p
  2. color: #ff7000; /*字体颜色设置*/
  3. height:30px; /*段落高度设置*/

 

JS 注释标签

单行注释

单行注释以 // 开头。

任何位于 // 与行末之间的文本都会被 javascript 忽略(不会执行)。

本例在每条代码行之前使用单行注释:

实例

// 改变标题:
 document.getElementById("myH").innerHTML = "我的第一张页面";
// 改变段落:
 document.getElementById("myP").innerHTML = "我的第一个段落。";

本例在每行结尾处使用了单行注释来解释代码:

实例

var x = 5;      // 声明 x,为其赋值 5
var y = x + 2;  // 声明 y,为其赋值 x + 2

 

多行注释

多行注释以 /* 开头,以 */ 结尾。

任何位于 /* 和 */ 之间的文本都会被 JavaScript 忽略。

本例使用多行注释(注释块)来解释代码:

实例

/*
 下面的代码会改变
 网页中
 id = "myH" 的标题
 以及 id = "myP" 的段落:
*/
document.getElementById("myH").innerHTML = "我的第一张页面";
document.getElementById("myP").innerHTML = "我的第一个段落。"; 

 

注释:使用单行注释最为常见。

提示:注释块常用于官方声明。

 

Java:有两种注释方式,分别是 单行注释,多行注释;

单行注释

 

单行注释以两个正斜杠//开始,后面的内容是注释内容。

 

//被Java忽略(不执行)。

 

本例中使用的代码行前的单行注释:

 

1
2
// 这是单行注释,这里的内容不会被执行
System.out.println("Hello Java");

 

多行注释

 

多行注释以/*开始且以*/结尾。

 

/*之间的任何文本*/将被Java忽略。

 

此示例使用多行注释(注释块)来解释的代码:

 

1
2
3
4
/**
 * 这是单多注释,这里的内容不会被执行
 */
System.out.println("Hello Java");

 

 


二 为什么要写注释?

1.注释用于解释 JavaScript 代码,增强其可读性。

2.注释也可以用于在测试替代代码时阻止执行。

3.使用注释来阻止执行

使用注释来防止代码执行很适合代码测试。

在代码行之前添加 // 会把可执行的代码行更改为注释。

本例使用 // 来阻止代码行的执行:

实例

//document.getElementById("myH").innerHTML = "我的第一张页面";
document.getElementById("myP").innerHTML = "我的第一个段落。"; 

 

本例使用注释块来阻止多行代码的执行:

实例

/*
document.getElementById("myH").innerHTML = "我的第一张页面";
document.getElementById("myP").innerHTML = "我的第一个段落。";
*/

 

 


HTML、CSS、JavaScript、Java它们的注释有哪些相同和不同?

HTML:只有一种注释方式:<!-- 在此处写注释内容 -->

 

CSS:有两种注释方式,分别是 单行注释,多行注释;

单行注释:/* 在此处写注释内容 */ 

   技术图片

 注意到了,单选注释时,星号必须和内容保留一个空格。

 

多行注释:/**

      *

      *

      */

技术图片

 

看出来了,星号要对齐,星号和内容之间必须保留一个空格。

 

块内注释

技术图片

 

块内注释,比如SCSS文件里就可以这么注释,也需要注意,//后面加上一个空格,注释独立一行。

 

文件注释

技术图片

 

一般文件顶部必须包含详细的文件注释,这样另一个人查看时才顺手。甚至自己今后翻看时也能更清晰。上面看出,用@name标识文件说明,星号要一列对齐,星号与内容之间必须保留一个空格,标识符冒号与内容之间必须保留一个空格。

其中@update为可选项,建议每次改动都更新一下。

当该业务项目主要由固定的几个人负责时,另外要添加@author,写上作者名称。一方面,尊重劳动成果。另一方面方便在需要时快速责任人。

总结一下:

这些规则很容易被忽略掉,好的注释能大大提高代码的质量,同时JS文件也适应。

 

JavaScript:有两种注释方式,分别是 单行注释,多行注释;

单行注释:// 在此处写注释内容;

多行注释: /* 在此处写注释内容 */ ;(多行注释以 /* 开始,以 */ 结尾。

 

Java:有两种注释方式,分别是 单行注释,多行注释;

单行注释

 

单行注释以两个正斜杠//开始,后面的内容是注释内容。

 

//被Java忽略(不执行)。

 

本例中使用的代码行前的单行注释:

 

1
2
// 这是单行注释,这里的内容不会被执行
System.out.println("Hello Java");

 

多行注释

 

多行注释以/*开始且以*/结尾。

 

/*之间的任何文本*/将被Java忽略。

 

此示例使用多行注释(注释块)来解释的代码:

 

1
2
3
4
/**
 * 这是单多注释,这里的内容不会被执行
 */
System.out.println("Hello Java");

 

以上是关于回顾之前知识: 注释的主要内容,如果未能解决你的问题,请参考以下文章

Java知识回顾 (15) 文档注释

前端基础知识入门概要(自我回顾用)

20180112软工提问回顾

Java基础知识回顾之七 ----- 总结篇

Java基础知识回顾之七 ----- 总结篇

我的Java知识复习回顾笔记