编程里注释
A. 编程中的注释分为三类 单行注释,多行注释,文档注释;
晕~~~ 自己还是找到了 ·· 留给后来人吧···
http://www.diybl.com/course/3_program/java/javajs/2008911/141971.html
java文档注释(有示例)
Java代码规范--注释
@author LEI
@version 1.10 2005-09-01
1 注释文档的格式注释文档将用来生成HTML格式的代码报告,所以注释文档必须书写在类、域、构造函数、方法、定义之前。注释文档由两部分组成——描述、块标记。
例如:
/**
* The doGet method of the servlet.
* This method is called when a form has its tag value method equals to get.
*
* @param request
* the request send by the client to the server
* @param response
* the response send by the server to the client
* @throws ServletException
* if an error occurred
* @throws IOException
* if an error occurred
*/
public void doGet (HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException {
doPost(request, response);
}
前两行为描述,描述完毕后,由@符号起头为块标记注视。
2 注释的种类2.1 文件头注释
文件头注释以 /*开始,以*/结束,需要注明该文件创建时间,文件名,命名空间信息。
例如:
/*
* Created on 2005-7-2
* /
2.2 类、接口注释
类、接口的注释采用 /** … */,描述部分用来书写该类的作用或者相关信息,块标记部分必须注明作者和版本。
例如:
/**Title: XXXX DRIVER 3.0
*Description: XXXX DRIVER 3.0
*Copyright: Copyright (c) 2003
*Company:XXXX有限公司
*
* @author Java Development Group
* @version 3.0
*/
例如:
/**
* A class representing a window on the screen.
* For example:
*
* Window win = new Window(parent);
* win.show();
*
*
* @author Sami Shaio
* @version %I%, %G%
* @see java.awt.BaseWindow
* @see java.awt.Button
*/
class Window extends BaseWindow {
...
}
2.3 构造函数注释
构造函数注释采用 /** … */,描述部分注明构造函数的作用,不一定有块标记部分。
例如:
/**
* 默认构造函数
*/
有例如:
/**
* 带参数构造函数,初始化模式名,名称和数据源类型
*
* @param schema
* Ref 模式名
* @param name
* Ref 名称
* @param type
* byVal 数据源类型
*/
2.4 域注释
域注释可以出现在注释文档里面,也可以不出现在注释文档里面。用/** … */的域注释将会被认为是注释文档热出现在最终生成的HTML报告里面,而使用/* … */的注释会被忽略。
例如:
/* 由于triger和表用一个DMSource,所以要区分和表的迁移成功标记 */
boolean isTrigerSuccess = false;
又例如:
/** 由于triger和表用一个DMSource,所以要区分和表的迁移成功标记 */
boolean isTrigerSuccess = false;
再例如:
/**
* The X-coordinate of the component.
*
* @see #getLocation()
*/
int x = 1263732;
2.5 方法注释
方法注释采用 /** … */,描述部分注明方法的功能,块标记部分注明方法的参数,返回值,异常等信息。例如:
/**
* 设置是否有外码约束
*
* @param conn
* Connection 与数据库的连接
*/
2.6 定义注释
规则同域注释。
3 注释块标记3.1 标记的顺序
块标记将采用如下顺序:
…
*
* @param (classes, interfaces, methods and constructors only)
* @return (methods only)
* @exception (@throws is a synonym added in Javadoc 1.2)
* @author (classes and interfaces only, required)
* @version (classes and interfaces only, required. See footnote 1)
* @see
* @since
* @serial (or @serialField or @serialData)
* @deprecated (see How and When To Deprecate APIs)
* …
一个块标记可以根据需要重复出现多次,多次出现的标记按照如下顺序:
@author 按照时间先后顺序(chronological)
@param 按照参数定义顺序(declaration)
@throws 按照异常名字的字母顺序(alphabetically)
@see 按照如下顺序:
@see #field
@see #Constructor(Type, Type...)
@see #Constructor(Type id, Type id...)
@see #method(Type, Type,...)
@see #method(Type id, Type, id...)
@see Class
@see Class#field
@see Class#Constructor(Type, Type...)
@see Class#Constructor(Type id, Type id)
@see Class#method(Type, Type,...)
@see Class#method(Type id, Type id,...)
@see package.Class
@see package.Class#field
@see package.Class#Constructor(Type, Type...)
@see package.Class#Constructor(Type id, Type id)
@see package.Class#method(Type, Type,...)
@see package.Class#method(Type id, Type, id)
@see package
3.2 标记介绍
3.2.1 @param标记
@param后面空格后跟着参数的变量名字(不是类型),空格后跟着对该参数的描述。
在描述中第一个名字为该变量的数据类型,表示数据类型的名次前面可以有一个冠词如:a,an,the。如果是int类型的参数则不需要注明数据类型。例如:
…
* @param ch the char 用用来……
* @param _image the image 用来……
* @param _num 一个数字……
…
对于参数的描述如果只是一短语,最好不要首字母大写,结尾也不要句号。
对于参数的描述是一个句子,最好不要首字母大写,如果出现了句号这说明你的描述不止一句话。如果非要首字母大写的话,必须用句号来结束句子。(英文的句号)
公司内部添加ByRef和ByVal两个标记,例如:
* @param _image the image ByRef 用来……
说明该参数是引用传递(指针),ByVal可以省略,表示是值传递。
3.2.2 @return标记
返回为空(void)的构造函数或者函数,@return可以省略。
如果返回值就是输入参数,必须用与输入参数的@param相同的描述信息。
必要的时候注明特殊条件写的返回值。
3.2.3 @throws 标记
@throws以前使用的是@exception。
@throws的内容必须在函数的throws部分定义。
3.2.4 @author标记
类注释标记。
函数注释里面可以不出现@author。
3.2.5 @version
类注释标记。
文章出处:http://www.diybl.com/course/3_program/java/javajs/2008911/141971.html
B. c语言注释符号是什么
单行注释和成对注释。单行注释以双斜线(//)开头。同一行中斜线右侧的所有内容都是注释,会被编译器略过。 另一个分隔符是注释符号对(/* */),它继承自C语言。
C语言是一门面向过程的、抽象化的通用程序设计语言,广泛应用于底层开发。C语言能以简易的方式编译、处理低级存储器。C语言是仅产生少量的机器语言以及不需要任何运行环境支持便能运行的高效率程序设计语言。
尽管C语言提供了许多低级处理的功能,但仍然保持着跨平台的特性,以一个标准规格写出的C语言程序可在包括类似嵌入式处理器以及超级计算机等作业平台的许多计算机平台上进行编译。
最新的C语言标准是C18。
C语言是一门面向过程的计算机编程语言,与C++、C#、Java等面向对象编程语言有所不同。C语言的设计目标是提供一种能以简易的方式编译、处理低级存储器、仅产生少量的机器码以及不需要任何运行环境支持便能运行的编程语言。
C语言描述问题比汇编语言迅速、工作量小、可读性好、易于调试、修改和移植,而代码质量与汇编语言相当。C语言一般只比汇编语言代码生成的目标程序效率低10%-20%。因此,C语言可以编写系统软件。
当前阶段,在编程领域中,C语言的运用非常之多,它兼顾了高级语言和汇编语言的优点,相较于其它编程语言具有较大优势。计算机系统设计以及应用程序编写是C语言应用的两大领域。同时,C语言的普适较强,在许多计算机操作系统中都能够得到适用,且效率显着。
C语言拥有经过了漫长发展历史的完整的理论体系,在编程语言中具有举足轻重的地位。
C. 编程中的注释其实也是语言表示数字和数据而已吗
光看代码可以懂得,但是对于相对复杂的代码来说,逻辑原理和变量参数的变化是非常复杂的,需要借助东西来记忆,注释则消除了这些复杂性,比如一个函数a()他的功能和意义在没有注释的时候需要别人自己去解读,假如我已经注释他是一个冒泡算法的话,别人就知道他实现的意义了
D. 编程中//注释怎么打出来,那几个键啊
不同的编程语言注释符也不一样。
// 这是就是 “?”键下面"/",按两下即可
E. 关于各种编程语言的注释
c
行注释:none
块注释:/*这里是注释*/
扩展名:.c/.h
c++
行注释://这里是注释
块注释:/*这里是注释*/
扩展名:.cpp/.h
vb
行注释:'这里是注释
块注释:none
扩展名:.bas
java
行注释://这里是注释
块注释:/*这里是注释*/
扩展名:.java
.net
dotnet is not a language!
is a platform.
vb.net
行注释:'这里是注释
块注释:none
xml注释:///这里是xml注释
扩展名:.vb
perl
行注释:#这里是注释
块注释:none
扩展名:.pm
c#
行注释://这里是注释
块注释:/*这里是注释*/
xml注释:///这里是xml注释
扩展名:.cs
html
行注释:none
块注释:<!--这里是注释-->
扩展名:.htm/.html
F. 怎样在三菱PLC编程软件中插入注释
1、打开三菱PLC编程软件的主页,需要确定一段简单的程序。
G. 编程的时候什么样的注释方法最好
一般用到的或者说大多数程序员爱用的就是行注释与块注释,行注释典型的为//,块注释典型的为/* xxxxxxx */ 。注释太多不好,太少更不好,相比来说多比少好,恰当最好。注释在什么地方,一般页头处,说明该页干什么的。函数声明处,说明函数是干什么的。其它地方你觉得别人可能看不懂的地方都应注释一下。
H. 在网页编程中如何进行注释
html代码的注释格式是:<!--这里写注释的内容(不能再出现“--”,否则容易出错)-->
脚本或者样式的(多行)注释格式是:/*注释内容写在这里*/
脚本或者样式的(单行)注释格式是://注释内容写在这里