代码注释

前言

本来只准备写一个关于MySQL的注释问题,到想写的时候就想把我目前所用过的所有代码注释写上,就当做个笔记。有错误的地方或者不足的之处烦请之处,以便修改,谢谢。

MySQL注释

MySQL注释是(例子如下所示):–MySQL注释

--创建数据库
create database jxdb;
use jxdb; --建教师表
create table T (
T# char(4) NOT NULL, --主键,不为空,自增
TNAME char(8) not null,--教师名称
TITLE char(10),--所教学科 primary key(T#)
);

java注释 对于java注释有三种:

1.单行注释:


//System.out.println("单行注释");

如果是使用myeclipse或者eclipse的IDE,可以直接选中所想注释的,然后同时按下‘Ctrl’和‘/’(反斜杠),就可以直接注释,也可以一次执行多行。

String randCheckCode = (String) request.getSession().getAttribute( "randCheckCode"); // 取得验证码

2.多行注释

以’/‘开头,然后按下enter,后半部分会自动补全。每按一次下一行会自动在前面补全’ ‘。但要注意的地方是注释不能相互嵌套,原因自行脑补。

/*
         * 这个就是传说中的多行注释 
         * 
         */

3.文档注释

/** 
          * TODO ajax验证用户名是否存在 
         * @param userName 
         * @return
         * String 
         * @author zw 
         * 2015年6月17日下午1:30:26 
         */ 
        @RequestMapping("userNameValidateAjax")
         public @ResponseBody String userNameValidate(String userName){ 
            User user1 = userService.findUserByUserName(userName); 
            if(user1 != null)
            { 
                return "exist";
                }else{ 
                    return "notexist";
                    } 
            } 

jsp与html注释

jsp和html的代码是有一点区别的 html和jsp都可以用
<!-- footer start--><!-- footer end st-art->
来注释,但是这个可以在客户端查看到,就是可以通过右键,查看源代码查看到(例子如下所示)。

<div id="footer"><!-- footer start--> 
      <div class="copyright"> Copyright © 2015 <a href="/LinkST/index/agreement" target="_blank">LinkST平台服务协议</a> 
      </div> 
</div><!-- footer start-->

同时jsp可以使用另外一种注释,由于jsp可以嵌入java代码,然后jsp作为字节码直接编译执行,所以不会再客户端查看源代码显示出来,即对外是不可见的。jsp中可以嵌入java代码,当然也可以在jsp嵌入的java代码使用java注释。
<%-- JSP中的注释,看不见 --%>
<%
System.out.println("helloworld"); //这个注释也看不见
/* 注释,看不见 */
/**
*当然这个注释也看不见
*/
%>

c/c++注释

c语言与c++的注释一样,下面是一个c++的注释例子。

单行注释以 // 开头
printf("helloworld");//c、c++单行注释

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

/*当然c、c++也可以这样注释 这个是文档注释,也可以是多行*/ 
       int main(int argc,char* argv[]) 
       { 
               //决定其行为是父进程还是子进程 这个是单行注释 
               if(argc >1 && ::strcmp(argv[1],"child")==0) {
                Child(); 
               }
                else { Parent(); 
               }
                return 0;
        }

js注释

单行注释以 // 开头
//Ajax进行登录的异步验证

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

但是我在使用过程中,发现js的注释和java注释使用好像没什么太大的差别。使用单行注释最多,也可以按ctrl+’/’一次实现多行注释。 不过最好还是以上面的为准(例子如下)。

//Ajax进行登录的异步验证 单行注释
/*
多行注释
*/
/**
* 文档注释
*/

评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值