方法的注释怎么写( 三 )


例如
/**
* @name 名字
* @abstract 申明变量/类/方法
* @access 指明这个变量、类、函数/方法的存取权限
* @author 函数作者的名字和邮箱地址
* @category 组织packages
* @copyright 指明版权信息
* @const 指明常量
* @deprecate 指明不推荐或者是废弃的信息MyEclipse编码设置
* @example 示例
* @exclude 指明当前的注释将不进行分析,不出现在文挡中
* @final 指明这是一个最终的类、方法、属性,禁止派生、修改 。
* @global 指明在此函数中引用的全局变量
* @include 指明包含的文件的信息
* @link 定义在线连接
* @module 定义归属的模块信息
* @modulegroup 定义归属的模块组
* @package 定义归属的包的信息
* @param 定义函数或者方法的参数信息
* @return 定义函数或者方法的返回信息
* @see 定义需要参考的函数、变量,并加入相应的超级连接 。
* @since 指明该api函数或者方法是从哪个版本开始引入的
* @static 指明变量、类、函数是静态的 。
* @throws 指明此函数可能抛出的错误异常,极其发生的情况
* @var 定义说明变量/属性 。
* @version 定义版本信息
*/
PHPdoc 可以帮你自动生成代码文档 。这个就方便很多了 。
5. 毕业论文的注释是什么 你可以参考下面的格式 。
关键词是从论文的题名、提要和 正文中选取出来的,是对表述论文的中心内容有实质意义的词汇 。关键词是用作计算机系统标引论文内容特征的词语,便于信息系统汇集,以供读者检索 。每篇论文一般选取3-8个词汇作为关键词,另起一行,排在“提要”的左下方 。主题词是经过规范化的词,在确定主题词时,要对论文进行主题分析,依照标引和组配规则转换成主题词表中的规范词语 。(参见《 汉语主题词表》和《世界汉语主题词表》) 。
论文正文
(1) 引言:引言又称前言、序言和导言,用在论文的开头 。引言一般要概括地写出作者意图,说明选题的目的和意义,并指出论文写作的范围 。引言要短小精悍、紧扣主题 。〈2)论文正文:正文是论文的主体,正文应包括论点、论据、论证过程和结论 。主体部分包括以下内容: a.提出问题- 论点; b.分析问题-论据和论证; c.解决问题-论证方法与步骤; d. 结论 。
参考文献
一篇论文的参考文献是将论文在研究和写作中可参考或引证的主要文献资料,列于论文的末尾 。参考文献应另起一页,标注方式按《GB7714-87文后参考文献著录规则》进行 。
论文装订
论文的有关部分全部抄清完了,经过检查,再没有什么问题,把它装成册,再加上封面 。论文的封面要朴素大方,要写出论文的题目、学校、科系、指导教师姓名、作者姓名、完成年月日 。论文的题目的作者姓名一定要写在表皮上,不要写里面的补页上 。

方法的注释怎么写

文章插图