欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

如何给asp,html,javascript,php添加注释语句

程序员文章站 2022-07-01 23:05:18
如何给asp中的语句添加注释?很简单,直接在每行后面要注释的地方,打上英文单引号(')就可以注释代码。有些朋友也问到过asp如何添加多行注释的问题,其实asp是没多行注释的说法,现在通常为a...
如何给asp中的语句添加注释?很简单,直接在每行后面要注释的地方,打上英文单引号(')就可以注释代码。有些朋友也问到过asp如何添加多行注释的问题,其实asp是没多行注释的说法,现在通常为asp添加多行注释其实就是变通一下,每行用',有的编辑器里面也提供了多行选中后一起注释的,也无非就是每行头加一个'。

  html中单行注释用: <!--这里是注释的内容-->,多行注释用:<!--这里是多行注释-->。

  javascript中单行注释用://注释一行,多行注释用:/*注释*/  注释一段。

  php注释和javascript的用法一样;

一些注释规范

a.注释必须是

/**

* xxxxxxx

*/

的形式

b.对于引用了全局变量的函数,必须使用glboal标记。

c.对于变量,必须用var标记其类型(int,string,bool...)

d.函数必须通过param和return标记指明其参数和返回值

e.对于出现两次或两次以上的关键字,要通过ingore忽略掉多余的,只保留一个即可

f.调用了其他函数或类的地方,要使用link或其他标记链接到相应的部分,便于文档的。

g.必要的地方使用非文档性注释,提高代码易读性。

h.描述性内容尽量简明扼要,尽可能使用短语而非句子。

i.全局变量,静态变量和常量必须用相应标记说明