代码注释标准大全

/**
* @name 名字
* @abstract 申明变量/类/方法
* @access 指明这个变量、类、函数/方法的存取权限
* @author 函数作者的名字和邮箱地址
* @category 组织packages
* @copyright 指明版权信息
* @const 指明常量
* @deprecate 指明不推荐或者是废弃的信息
* @example 示例
* @exclude 指明当前的注释将不进行分析,不出现在文挡中
* @final 指明这是一个最终的类、方法、属性,禁止派生、修改。
* @global 指明在此函数中引用的全局变量
* @include 指明包含的文件的信息
* @link 定义在线连接
* @module 定义归属的模块信息
* @modulegroup 定义归属的模块组
* @package 定义归属的包的信息
* @param 定义函数或者方法的参数信息
* @return 定义函数或者方法的返回信息
* @see 定义需要参考的函数、变量,并加入相应的超级连接。
* @since 指明该api函数或者方法是从哪个版本开始引入的
* @static 指明变量、类、函数是静态的。
* @throws 指明此函数可能抛出的错误异常,极其发生的情况
* @todo 指明应该改进或没有实现的地方
* @var 定义说明变量/属性。
* @version 定义版本信息
*/
时间: 2024-08-09 14:41:12

代码注释标准大全的相关文章

华为代码注释标准

/**************************************************************************** File name:    count.c Directory:     /home/luo/myfile/c/20161114/ Author:         lijing Description:       1.运算符使用      2.运算符总结      3.打印 Others: 暂无说明 History: 1.添加打印功能   

前端代码注释

经常需要用到代码注释,一直都是用编辑器自带的快捷键做注释.也有特意留意在各种环境下的注释方式,但经常在手输的时候还是会用混,不知道用哪种注注释方式. 对于前端,每天打交道的大概就是html,css,js,而前端的代码注释方式只有三种(至少我每天用到的,不排除有别的高级注释方法,呵呵):1:<!-- -->  2:/**/   3:// 在html中的注释方式:<!--内容 --> 在css中的注释方式:块注释:/*内容*/ 估且称为“伪单行注释”(让css无法解析而绕过的方式达到去

GhostDoc Pro v4.9.14093.Cracked.By.SubMain 一款好用的代码注释生成工具——VS插件

原文:GhostDoc Pro v4.9.14093.Cracked.By.SubMain 一款好用的代码注释生成工具--VS插件 一款比较好用的 VS 插件,能够快速生成注释. 这是 Pro 版本,与标准版本相比,支持对类.文件批量生成注释并且可以生成 CHM 帮助文件. 具体差异请转到: http://submain.com/products/ghostdoc.aspx 简化你的XML注释! GhostDoc是一个Visual Studio扩展,自动生成基于其类型,参数,名称和其他上下文信息

代码注释规范

代码注释规范 一. 注释规范 1. 修改代码时,总是使代码的注释保持最新, 为了防止问题反复出现,对错误修复和解决方法代码必须使用注释. 2. 在每个函数.方法的开始,应该提供标准的注释以指示例程的用途,注释样本应该是解释它为什么存在和可以做什么的简短介绍. 3. 避免在代码行的末尾添加注释:行尾注释使代码更难阅读. 4. 在变量声明时,应在行尾添加注释:在这种情况下,将所有行尾注释应使用公共制表符(Tab)在一处对齐. 5. 避免杂乱的注释,如一整行星号.而是应该使用空白将注释同代码分开. 6

代码注释(Code comments)

代 码 注 释(Code comments) 在理解三层和机房三层+设计模式时,特别是三层运行时,师傅狠狠的指导了一 番,必须要一行一行运行原则,和怎么运行的,自己要能说出是怎么运行出来. 当初查 了一些网上资料,稂莠不齐,所以自己总结了一些代码注释的原则,还请多多指点: 代码的标准是英文,它的母语就是英文,现在不论是中国人.日本人还是俄国人在 开发软件,为了更好的理解和开发软件,都很有必要写一些相应的注释,为了更好的更 改.维护等工作,代码注释不是必须的,但是它可以提高程序的可读性,建议养成写

从开源项目看python代码注释

最近看了不少代码,也写了不少代码,所以在看和写之间发现了很多的问题,真的是很多,至少从我的认识来看,有几个地方有很大的改进空间,这里不准备把所有的问题都列举出来,所以就先挑选一个比较明显得来和大家聊聊.回顾流行开源项目的成功,除了功能上的刚需之外,文档也是必不可少的一个环节,没有良好文档的开源项目几乎不可能说是流行的,因为很少人会因为你说了一句使用我的项目就可以怎么怎么样就傻不溜秋得用你的.从我以前开源的项目中大家可能会发现一个比较大的问题就是文档工作做得确实不咋地. 项目中的文档我认为可以分为

谈代码注释

只要写代码,就会遇到代码注释的问题.在不同的公司,不同的项目组,不同的项目中,可能会有不同的注释标准.有些标准让我们感觉很受益,有些则让我们感觉很反感.而对于没有明确标准的项目,我们往往会遇到“百家齐放,百家争鸣”般的注释.我无法给出一个明确的标准,只是在此探讨下:什么样的注释不应该写,什么地方需要写注释.“不”的原则不是每行代码都需要写注释这个原则源于之前我和同事的一个争论.当时我们讨论代码注释该怎么写的问题,最终同事抛出这么一个观点:“我之前在X为干过,那儿就需要每行代码都写注释,所以我们应

PHPDocumentor代码注释规范说明

   PHPDocumentor是一个的用PHP写的道具,对于有规则注释的php程序,它能够快速生成具有相互参照,索引等功能的API文档. 标记 用途 描述 @abstract   抽象类的变量和方法 @access public, private or protected 文档的访问.使用权限. @access private 表明这个文档是被保护的. @author 张三 <[email protected]> 文档作者 @copyright 名称 时间 文档版权信息 @deprecate

EA强大功能之代码注释

前面讲了EA如何方便我们生成代码,这次讲一下,如何生成详细的注释. 1.文件表头注释 (1)点击工具----选项 在常规项里修改作者: 在代码工程中修改代码工程的默认语言. (2)修改文件模板 点击代码工厂模板以后如图: 修改语言--点击File,修改模板.点击保存.完成. 2.类表头注释:(以SqlUserDAL类为例) 修改类的信息,如图所示: 3.方法前注释 添加一个类的方法,填写齐全的信息.如图: 法前的注释主要是介绍本方法的功能以及参数,所以填写全这两个就行. 4.参数的注释 点击编辑