A股上市公司传智教育(股票代码 003032)旗下技术交流社区北京昌平校区

 找回密码
 加入黑马

QQ登录

只需一步,快速开始

© meibinlove 中级黑马   /  2014-7-30 11:17  /  1562 人查看  /  12 人回复  /   0 人收藏 转载请遵从CC协议 禁止商业使用本文

在代码中如何写注释,都有什么地方应该写注释,求前辈指导啊

12 个回复

倒序浏览
//你在逗我吗?
回复 使用道具 举报
注释有两种:
1、以//为起始,//之后的整行内容都为注释
2、以/*为起始,以*/为结束,表示这个块为注释

关于注释的使用位置,其实,开发中,常用的,反而是第二种注释的变形:/**起始,*/结束
这个是文档注释,一般标在文件开头(有可能写文件的简介、作者、思路、更新情况、版权等),以及每个函数前(有可能写:函数的作用、参数列表、返回值类型与作用,有点类似JavaAPI文档这样子的东东)。

还有就是程序的一些关键点,或者比较容易混淆的地方,用//注释特别标记或者指出(在同一行,或者上行、下行)
回复 使用道具 举报
//单行注释

/*
多行
注释
*/

/**
文档注释
*/
回复 使用道具 举报
   1--类,函数加的是文档注释   --如果修饰符有改变话可以加多行注释-  2--行注释用在代码中的某几句比较关键难懂 注意:不要每行都加注释  
回复 使用道具 举报
这个。。。。 好难回答啊, 不知道楼主是故意的还是。。
回复 使用道具 举报
liubea 中级黑马 2014-7-30 14:43:14
7#
同意楼上
回复 使用道具 举报
同意6楼~~
回复 使用道具 举报

我知道//,/**/,/***/,这些注释,我的意思是在什么地方加注释,都要对那些内容进行注释说明
回复 使用道具 举报

我知道这些,我想知道的是都是那些地方需要注释说明
回复 使用道具 举报
南柯一梦 发表于 2014-7-30 14:25
1--类,函数加的是文档注释   --如果修饰符有改变话可以加多行注释-  2--行注释用在代码中的某几句比较 ...

能不能具体举例说明一下,谢谢
回复 使用道具 举报
青偆丶易逝〃 发表于 2014-7-30 14:41
这个。。。。 好难回答啊, 不知道楼主是故意的还是。。

我是真想知道,有时候自己写点东西,想加注释,但是有不知道在什么地方加,都要对那些东西进行注释说明
回复 使用道具 举报
Java中有三种注释:注释不会被编译器编译。不影响最后生产的class文件
一:单行注释:用于注释单行代码
    //单行注释;
二:多行注释:用于注释多行代码
    /*
     *多行注释
     */
三:文档注释:文档注释,可以生产HTML文档。
    /**
     *文档注释
     *@author WY
     */
注释的使用地点:类前面,方法前面,变量前面。。。具体的看实际情况的需要。
回复 使用道具 举报
您需要登录后才可以回帖 登录 | 加入黑马