C语言注释规范

更新时间:2023-07-21 15:11:12 阅读: 评论:0

@access
  使用范围:class,function,var,define,module
观音菩萨的来历
  该标记用于指明关键字的存取权限:private、public或proteced
  @author
  指明作者
  @copyright
  使用范围:class,function,var,define,module,u
  指明版权信息
  @deprecated
  使用范围:class,function,var,define,module,constent,global,include
  指明不用或者废弃的关键字
  @example
  该标记用于解析一段文件内容,并将他们高亮显示。Phpdoc会试图从该标记给的文件路径中读取文件内容
  @const
  使用范围:define
  用来指明php中define的常量
公司聚餐通知  @final
  使用范围:class,function,var
  指明关键字是一个最终的类、方法、属性,禁止派生、修改。
  @filesource
  和example类似,只不过该标记将直接读取当前解析的php文件的内容并显示。
  @global
  指明在此函数中引用的全局变量
  @ingore
  用于在文档中忽略指定的关键字
  @licen
  相当于html标签中的<a>,首先是URL,接着是要显示的内容
  例如<a href=””>百度</a>
  可以写作 @licen 百度
  @link
  类似于licen
  但还可以通过link指到文档中的任何一个关键字五行属金的字男孩常用
公主裙怎么画  @name
  为关键字指定一个别名。
  @package
  使用范围:页面级别的-> define,function,include
  类级别的->class,var,methods
  用于逻辑上将一个或几个关键字分到一组。牟宗三
  @abstrcut
  说明当前类是一个抽象类
  @param
  指明一个函数的参数
  @return
成年金毛
  指明一个方法或函数的返回指
  @static
  指明关建字是静态的。
  @var
  指明变量类型
  @version社区书记述职报告
  指明版本信息
  @todo
  指明应该改进或没有实现的地方
  @throws
  指明此函数可能抛出的错误异常,极其发生的情况
  上面提到过,普通的文档标记标记必须在每行的开头以@标记,除此之外,还有一种标记叫做inline tag,用{@}表示,具体包括以下几种:
堆糖壁纸  {@link}
  用法同@link
  {@source}
  显示一段函数或方法的内容

本文发布于:2023-07-21 15:11:12,感谢您对本站的认可!

本文链接:https://www.wtabcd.cn/fanwen/fan/82/1109151.html

版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系,我们将在24小时内删除。

标签:指明   标记   函数
相关文章
留言与评论(共有 0 条评论)
   
验证码:
推荐文章
排行榜
Copyright ©2019-2022 Comsenz Inc.Powered by © 专利检索| 网站地图