精华内容
下载资源
问答
  • HTML代码注释

    2015-12-05 22:07:29
    什么是代码注释代码注释的作用是帮助程序员标注代码的用途,过一段时间后再看你所编写的代码,就能很快想起这段代码的用途。代码注释不仅方便程序员自己回忆起以前代码的用途,还可以帮助其他程序员很快的读懂你的...

    什么是代码注释?代码注释的作用是帮助程序员标注代码的用途,过一段时间后再看你所编写的代码,就能很快想起这段代码的用途。代码注释不仅方便程序员自己回忆起以前代码的用途,还可以帮助其他程序员很快的读懂你的程序的功能,方便多人合作开发网页代码。

    语法:

    <!--注释文字 -->

    注释代码是不会在结果窗口中显示出来的。

    展开全文
  • notepad++编辑html代码代码注释不变颜色了,以前会变成绿色的。。
  • HTML注释

    千次阅读 2018-03-29 09:47:07
    lt;!-- 和 --&gt;标签之间的文本是文档的注释,注释的内容不会被显示在...1、HTML代码注释在一个大文档中,通过注释来标明区块的开始合结束的位置,可以方便查找,也可以通过注释来阻止某些内容显示。当编写...

    HTML注释

    在HTML代码中,<!-- 和 -->标签之间的文本是文档的注释,注释的内容不会被显示在浏览器页面上。只有在文本编辑器中,或浏览器的“查看源代码”选项打开文档时,才能看到注释。

    HTML中的注释有两种类型,一种是HTML代码注释,一种是IE条件注释。

    1、HTML代码注释

    在一个大文档中,通过注释来标明区块的开始合结束的位置,可以方便查找,也可以通过注释来阻止某些内容显示。

    当编写了大量代码时,对关键代码进行注释是一个良好的习惯,通过注释来说明某段代码的意图,有助于提醒自己或需要在这个网站上工作的其他人,了解这段代码的作用。

    使用注释来隐藏脚本,也是一个良好的习惯,这样一来,不支持脚本的浏览器就不会把脚本作为纯文本显示出来。如:

    1. <script type="text/javascript">
    2. <!--
    3. function displayMsg() {
    4.     alert("Hello World!")
    5. }
    6. //-->
    7. </script>

    2、IE条件注释

    IE条件注释(Conditional comments),是IE浏览器对HTML代码注释的一种扩展,它是一种非标准逻辑语句,可以灵活的为不同版本的IE导入不同html元素,如样式表、html标签等。

    条件注释在IE5首次出现,并得到后续版本的支持,其语法就是一个普通的HTML注释,IE以外的浏览器会把它作为注释而忽略。因此,它能通过W3C的校验,也不会对其他浏览器造成影响。

    条件注释的功能非常强大,可以进行 if 条件判断,并根据判断结果是true 或 false,来决定是否要解析条件注释里的内容。

    条件判断以 <!--[if 条件]> 开始,以<![endif]-->结束,可以根据IE、非IE进行判断,还可以根据IE的版本号进行判断,版本号可以精确到小数点后4位。如:

    1. <!--[if IE]> <![endif]-->      /* 所有IE,无论哪个版本 */
    2. <!--[if IE 6]> <![endif]-->    /* 如果IE版本是6 */

    条件判断中,还支持大于(gt: greater than)、小于(lt: less than)、大于等于(gte: greater than or equal)、小于等于(lte: less than or equal)、或(|)、与(&)、非(!)、括号。如:

    1. <!--[if gt IE 6]> <![endif]-->             /* 如果IE版本大于6 */
    2. <!-- [if lte IE 9]> <![endif]-->            / * 如果IE版本小于等于9 * /
    3. <!--[if IE 6 | IE 7]> <![endif]-->          /* 如果IE版本是6或7 */
    4. <!--[if ! IE 5.5]> <![endif]-->             /* 如果IE版本不是5.5 */
    5. <!-- [if (gt IE 6) & (lte IE 9)]> <![endif]-->  / * 如果IE版本大于6,且小于等于9 * /

    借助条件注释,可以解决很多IE兼容性问题。如,IE9以下的版本不支持HTML5的新元素 header、nav、aside、footer等,而在Internet上存在大量的 html5shiv脚本可以解决该问题。只需下载相应的脚本,并在页面的头部,通过IE条件注释,让IE9以下的版本加载该脚本,就可以让这些老浏览器支持HTML5的新元素。

    1. <!--[if lt IE 9]>
    2. <script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    3. <![endif]-->

    也可以使用同样的方法,来解决CSS的兼容性问题。如,IE6不支持一些CSS新特性,就可以专门针对IE6编写CSS文件,并只让IE6加载它:

    1. <!--[if IE 6]>
    2. <link rel="stylesheet" href="css/ie6.css" />
    3. <![endif]-->

    一个好消息是,从IE10版本开始,不再支持条件注释。这标志着IE从此走向成熟、走向标准,Web设计师再也不必为IE的兼容性问题所困扰了。

    版权声明:本文出自 歪脖网 的《HTML5宝典》,欢迎在线阅读,并提出宝贵意见。

    展开全文
  • 代码注释规范

    千次阅读 2019-01-07 15:05:13
    代码注释规范 一、后端代码注释 1.类(接口)注释 (1)使用swagger的项目 @Controller @RequestMapping("/testController") @Api(value="Controller的描述") public class TestController { ......

    代码注释规范

    一、后端代码注释

    1.类(接口)注释

    (1)使用swagger的项目

    @Controller
    @RequestMapping("/testController")
    @Api(value="Controller的描述")
    public class TestController {
    	...
    	...
    }
    
    /**
     * 
    * @TODO: (对service类进行功能描述) 
    * @author: Administrator 
    * @date: date{time} (日期)
     */
    public interface TestService {
    	...
    	...
    }
    

    (2)不使用swagger的项目

    /**
     * 
    * @TODO: (对Controller类进行功能描述) 
    * @author: Administrator 
    * @date: date{time} (日期)
     */
    @Controller
    @RequestMapping("/testController")
    public class TestController {
    	...
    	...
    }
    /**
     * 
    * @TODO: (对Service类进行功能描述) 
    * @author: Administrator 
    * @date: date{time} (日期)
     */
    public interface TestService {
    	...
    	...
    }
    

    2.方法注释

    (1)使用swagger

    1)1个参数
    	@ResponseBody
       	@ApiOperation(value="获取信息", notes="根据输入信息获取信息")
       	@ApiImplicitParam(name = "param1", value = "参数1", required = false, dataType = "String")
       	@RequestMapping(value = "/testFunction", method = RequestMethod.POST)
       	public Result testFunction(String param1) {
    		...
    		...
    	}
    
    2)多个参数
    	@ResponseBody
       	@ApiOperation(value="获取信息", notes="根据输入信息获取信息")
       	@ApiImplicitParams({
        	@ApiImplicitParam(name = "param1", value = "参数1", required = false, dataType = "String")
    	    @ApiImplicitParam(name = "param2", value = "参数2", required = false, dataType = "String")
        	@ApiImplicitParam(name = "param3", value = "参数3", required = false, dataType = "String")
    		@ApiImplicitParam(name = "param4", value = "参数4", required = false, dataType = "String") })
       	@RequestMapping(value = "/testFunction", method = RequestMethod.POST)
       	public Result testFunction(String param1, String param2,String param3,String param4) {
    		...
    		...    
    }
    

    (2)不使用swagger

    /**
    	 * 
    	* @TODO:(方法功能描述) 
    	* @param param1
    	* @param param2
    	* @return(展示方法参数和返回值)
    	 */
    @ResponseBody
    @RequestMapping("/testFunction")
    	public String testfunction(String param1,String param2) {
    			....
    }
    

    3.全局变量注释

    	/** 输入全局变量的注释. */
    	private final static Logger log = LoggerFactory.getLogger(WechatDownload.class);
    

    4.字段/属性注释

    (1)使用swagger

    @ApiModel(value = "测试信息")
    public class Test {
    
    	@ApiModelProperty(value = "id")
    	private String id ;
    
    	@ApiModelProperty(value = "名称")
    	private String name;
    
    	@ApiModelProperty(value = "类型")
    	private Integer type;
       	……
    }
    

    (2)不使用swagger

    /**
     * 
    * @TODO: Test实体类 
    * @author: Administrator 
    * @date: 2018-11-7 15:53:37 
     */
    public class Test {
    
    	private String id ; 			//id
    
    	private String name;			//名称
    
    	private Integer type;			// 类型
    
    	……
    }
    

    Swagger注释API详细说明:

    https://blog.csdn.net/xupeng874395012/article/details/68946676/

    二、前端代码注释

    1.HTML注释

    <!DOCTYPE html>
    <html>
    <body>
    <!--这是一段注释。注释不会在浏览器中显示。-->
    <p>这是一段普通的段落。</p>
    </body>
    </html>
    

    2.JavaScript、CSS注释

    (1)单行注释

    /* 黑色16象素文字 */ 
    .dreamdublack16px 
    { 
    	color:black; 
    	font-size:16px; 
    } 
    // 输出标题: 
    document.getElementById("myH1").innerHTML="欢迎来到我的主页"; 
    

    (2)多行注释

    /* 
    下面的这些代码会输出 
    一个标题和一个段落 
    并将代表主页的开始 
    */ 
    document.getElementById("myH1").innerHTML="欢迎来到我的主页";
    document.getElementById("myP").innerHTML="这是我的第一个段落。";
    

    (3)行末注释

    var x=5; // 声明 x 并把 5 赋值给它 
    var y=x+2; // 声明 y 并把 x+2 赋值给它
    
    展开全文
  • vscode 注释html代码

    万次阅读 2018-08-14 15:34:01
    但是今天我使用的时候发现了一件事,就是我在注释代码的时候,居然用 //来帮我注释HTML代码,下面看一下效果: 但是我看其他同事的电脑,他们都是可以正常生成{/**/}的注释,就像这个样子: 这个我就很纳闷了...

    vscode是一个非常优秀的编辑器,其中有很多出色的功能为编程带来巨大的便捷。但是今天我使用的时候发现了一件事,就是我在注释代码的时候,居然用 //来帮我注释HTML代码,下面看一下效果:
    这里写图片描述
    但是我看其他同事的电脑,他们都是可以正常生成{/**/}的注释,就像这个样子:
    这里写图片描述
    这个我就很纳闷了,本着不撞南墙不回头的决心,我决定对比各个配置,来找出到底是哪里出问题了。
    我查找了首选项里面的所有配置,均一无所获,然后我想到他们装的会不会有什么特殊的插件来实现这一功能,也没有。
    最后我发现了这里:
    这里写图片描述
    这其中有一个JavaScript,我猜想他是不是根据文件种类的不同来采取不同的注释方式呢?

    答案是确定的。

    这里大家只需要关注这个JavaScript,他把文件认定成为了js文件,所以注释会按照js的标准来注释,点击切换文件种类即可。

    我发现我比其他同事多装了一个插件:
    这里写图片描述
    当我把这个插件禁用之后,注释功能就可以使用了。

    展开全文
  • html怎么注释代码 HTML中的注释 (Comments in HTML) The comment tag is an element used to leave notes, mostly related to the project or the website. This tag is frequently used to explain something in ...
  • Javascript 代码注释规范

    千次阅读 2017-05-10 12:17:07
    javascript 代码注释规范 注释一般来说是好事情,但新手编程经常犯错误。他们写注释解释“代码是什么”,但这样解释性注释应该越少越好。 严肃地说,好的代码应该容易理解无需注释。有个极好规则:如果代码不清楚...
  • JavaScript代码注释范例

    千次阅读 2018-06-10 21:23:43
    #JavaScript代码注释范例&gt; 做为一个有情怀的Coder,最近收集了一下JavaScript代码注释范例,希望能够帮助大家撸得一手妖媚而又放荡的Bug。## 普通注释### 单行注释**使用 ```//``` 作为单行注释。****单行...
  • Html、CSS、JS代码注释的规范总结

    万次阅读 2012-06-20 23:26:12
    添加必要的注释,对一个有责任心、有道德模范的前端必须具备的好习惯,可以大大提高代码的可维护性、可读性。 首先熟悉一下html、css、js的注释的写法: 1、HTML注释语法: 2、css注释语法 /* ...
  • 代码注释对齐

    千次阅读 2011-09-22 21:47:55
    图1 图2 感觉上我们认为图2是我们想要的注释对齐的效果。但感觉是不能拿来代码实现的。...假设代码部分的长度为CL,代码到//之间的长度为Width。注释对齐实际上就是计算Width-CL,中间填充这么多个空格。 那么尝试定
  • vs code 写VUE代码 注释 html出现 //

    千次阅读 2019-07-08 20:49:00
    装个插件 "Vuter" 解决 转载于:https://www.cnblogs.com/ybixian/p/11153756.html
  • vscode代码注释与取消注释快捷键: ctrl+/
  • github上看各路大牛大神的项目代码,经常会看到各种神注释......那么问题就来了:大神是如何在代码里搞的这些图片代码呢?打死我也不信是大牛大神一个一个打上...
  • VUE代码注释规范,代码规范

    千次阅读 2019-08-15 10:52:09
    VUE代码注释规范,代码规范 背景 其实关于这一点我是深恶痛绝呀,你说我们吧eslint开了,来敲代码,就能把你的代码给规范了吧,关于组件命名和src结构都是按照VUE目录给的(项目成员已构造),功能注释和调试代码...
  • PHP代码注释规范

    千次阅读 2017-03-20 10:28:01
    给php代码添加规范的注释 更多参考 http://phpdoc.org/docs/latest/index.html 在phpdocumentor中,注释分为文档性注释和非文档性注释。 所谓文档性注释,是那些放在特定关键字前面的多行注释,特定关键字是指...
  • 前端代码注释分类

    千次阅读 2016-12-05 21:50:07
    HTML:; CSS:/* 注释内容*/ JS: //注 释内容; 或者/* 注释内容 */,
  • vscode前端代码注释模板使用介绍

    万次阅读 2019-01-04 15:17:16
    添加注释 ctrl+shift+p打开 输入snippets点击进入用户代码片段配置 配置css.json/css 进入之后输入 &amp;amp;amp;quot;Print to cssTitle&amp;amp;amp;quot;: { &amp;amp;amp;quot;prefix&...
  • HTML,CSS,JS,ASP等代码注释方法

    千次阅读 2010-05-06 08:45:00
    以下介绍几种常用的注释方法:一、HTML注释方法内容二、CSS的注释方法/* css注释*/在单独的css样式表文件中也采用此方法注释三、JS的注释方法单行注释以//开始多行注释以 /* 开头,以 */ 结尾。四、ASP的注释方法...
  • <!-- * @FileDescription: 该文件的描述信息 * @Author: 作者信息 * @Date: 文件创建时间 * @LastEditors: 最后更新作者 * @LastEditTime: 最后更新时间 -->
  • iOS 代码注释规范

    千次阅读 2017-02-06 10:38:06
    一、注释写法1.1 注释形式1.1.1 单行注释在很多时候只需写一个简要描述就够了,这时最好使用单行注释。推荐格式为// 简要描述.1.1.2 多行注释当需要写详细描述时,这时就需要使用多行注释了。推荐格式为/** 简要描述...
  • PHP标记和代码注释

    千次阅读 2015-05-07 12:33:08
    简单的PHP标记和PHP代码注释: 一.PHP标记 (1)XML标记风格 echo "这是XML标记风格!"; ?> (2)脚本标记风格
  • js/javascript代码注释规范与示例

    万次阅读 2016-10-15 10:46:40
    js/javascript代码注释规范与示例  注释在代码编写过程中的重要性,写代码超过半年的就能深深的体会到。没有注释的代码都不是好代码。为了别人学习,同时为了自己以后对代码进行‘升级’,看看js/...
  • java代码注释规范

    千次阅读 2018-03-20 22:05:50
    一、规范存在的意义 ...2、好的编码规范可以改善软件的可读性,可以让开发人员尽快而彻底地理解新的代码; 3、好的编码规范可以最大限度的提高团队开发的合作效率; 4、长期的规范性编码还可以让开发人...
  • IOS代码注释小结

    千次阅读 2015-06-05 16:50:18
    代码注释的必要性:想想看,半年之前代码,如果没有注释,是什么结果,擦,谁写的,写的啥?。。。好像是我写的。。 减少同事之间的沟通成本 快速恢复代码记忆 快速生成文档 注释的形式形式A: /// Single ...
  • Pascal-S代码注释

    千次阅读 2017-11-16 21:48:52
    注释参考博文 http://www.cnblogs.com/luxiaodou/p/6025124.html 注释代码 https://github.com/Hesitater/Pascal-S-Comments一些说明首先感谢luxiaodou同学对Pascal-S注释的开源,为大家读懂Pascal-S源码节省了不少...
  • rstudio 代码注释 “代码片段”仅仅是宏或模板- 和一个伟大的方式编写脚本时节省时间的另一个短语。 代码片段不仅可以减少您在编码时的击键; 他们还节省了您的搜索时间,以尝试查找六个月前就正确而又不再记得的...
  • jsx代码注释格式规范最全总结

    千次阅读 2020-05-02 01:52:36
    本文讲述了jsx代码注释的格式规范: 主要内容包括标签内注释、标签外注释、子组件标签上的注释 index.html、index.js、Comments.js、ChildComponent.js的代码如下: index.html: <!DOCTYPE html> <...
  • 这些代码都有着并不一致的注释方式。对于JSP和JS而言,其往往采用C语言是注释方式,如: 1 单行注释。插入单行注释的符号是“//”,举例如下: //********* Code; 2 多行注释。多行注释以"/*"开始,以"*/"结束,举例...

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 562,441
精华内容 224,976
关键字:

html代码注释