文件注释方法

每个人都有自己注释的风格,不强求格式一样。

基本注释内容:

  类注释:

/**
 * The control file of dashboard module of ZenTaoPMS.
 *
 * @copyright   Copyright 2009-2013 青岛易软天创网络科技有限公司 (QingDao Nature Easy Soft Network Technology Co,LTD www.cnezsoft.com)
 * @license     LGPL (http://www.gnu.org/licenses/lgpl.html)
 * @author      Chunsheng Wang <[email protected]>
 * @package     dashboard
 * @version     $Id: control.php 5020 2013-07-05 02:03:26Z [email protected] $
 * @link        http://www.zentao.net
 */

第一行写这个类的作用

  @copyright:自己的劳动成果最好加上这一句。

  @license:

  @author :名字和邮箱

  @package  dashboard

  @version  版本

  @link   说明,介绍。

  方法注释:

  

    /**
     * Construct function.
     *
     * @access public
     * @return void
     */

  短注释:

/* Save session. */

  变量说明:

$var //这是一个变量。

  

时间: 2024-10-08 17:48:44

文件注释方法的相关文章

ReSharper 文件注释

添加文件注释方法如下: 打开菜单RESHARPER->Options->Code Editing –> File Header Text 如图所示,在其中空白处添加对应文件头注释, 下面的Embrace file header with region with name中为包含注释的#region名.

Zend studio文件注释模板设置方法

步骤:Window -> PHP -> Editor -> Templates,这里可以设置(增.删.改.导入等)管理你的模板.新建文件注释.函数注释.代码块等模板的实例 新建模板,分别输入Name.Description.Pattern a)文件注释 Name: 3cfileDescription: tkyouxi.com文件注释模板 Pattern:/*** tkyouxi.com xx文件* =============================================

Matlab M文件“程序块”注释方法

方法一: 注释语句的快捷键是Ctrl+R 取消注释的快捷键是Ctrl+T 并且支持一次注释(或者取消注释)多行语句. 选定要注释(或者取消注释)的那些语句,然后按Ctrl+R(或者Ctrl+T)就可以了. 方法二: 采用matlab块注释方法 %{ 需要注释不执行的若干命令行 %} 注意:方法二以 % 开始,但是以 } 结束,不要搞反了.

头文件注释轻松搞—VS2013

随着学习的不断深入,我们也正在逐步触摸到职业化的门槛,就拿注释来说,良好的注释说明在职业化编程中是非常必要的,因为这有助于他人对程序的阅读理解,使小组之间交流起来更加便利. 这几天在编写重构机房收费系统,里面当然少不了注释,但是我对其中的一种注释却非常的头疼-文件头注释.因为头注释里面的内容多,而且每个类或窗体里面的头注释内容大多相似,所以每次新建一个类或窗体的时候都要复制粘贴(当然还得稍微修改一下).每次做这些重复的事情让我感到很无奈,所以就想到是不是有种方法可以让VS自动生成头注释呢?在网上

C#中常用的几种读取XML文件的方法

XML文件是一种常用的文件格式,例如WinForm里面的app.config以及Web程序中的web.config文件,还有许多重要的场所都有它的身影.Xml是Internet环境中跨平台的,依赖于内容的技术,是当前处理结构化文档信息的有力工具.XML是一种简单的数据存储语言,使用一系列简单的标记描述数据,而这些标记可以用方便的方式建立,虽然XML占用的空间比二进制数据要占用更多的空间,但XML极其简单易于掌握和使用.微软也提供了一系列类库来倒帮助我们在应用程序中存储XML文件. “在程序中访问

【转】matlab读取文件各种方法

本技术支持指南主要处理:ASCII, binary, and MAT files.要得到MATLAB中可用来读写各种文件格式的完全函数列表,可以键入以下命令: help iofun MATLAB中有两种文件I/O程序:high level and low level. High level routines: 包括现成的函数,可以用来读写特殊格式的数据,并且只需要少量的编程.Low level routines: 可以更加灵活的完成相对特殊的任务,需要较多的额外编程. High level ro

Linux中逐行读取文件的方法

  Linux中逐行读取文件的方法             在linux中有很多方法逐行读取一个文件的方法,其中最常用的就是下面的脚本里的方法,而且是效率最高,使用最多的方法.为了给大家一个直观的感受,我们将通过生成一个大的文件的方式来检验各种方法的执行效率. 方法1:while循环中执行效率最高,最常用的方法. function while_read_LINE_bottm(){ While read LINE do echo $LINE done   < $FILENAME } 注释:我习惯把

myeclipse 文件注释部分乱码问题

前几天安装了myeclipse,用了几天,写了一些Demo,并且都有注释,今天上午根据要求,重新配置了一下myeclipse,包括许多编码方式的改变,当时没在意,下午打开原来的Demo时,发现它们的注释部分全部乱码,所有的readme都乱码,不堪入目,经过尝试,发现原来是文件保存的编码问题. 单个文件查看编码格式(也就是打开文件用的编码格式)更改. 这个方法没有更改文件的编码格式,只是告诉MyEclipse用何种编码格式进行解码.在要查看的文件上,如文件Test.java上右键-->Proper

调试SQLSERVER (一)生成dump文件的方法

调试SQLSERVER (一)生成dump文件的方法 调试SQLSERVER (二)使用Windbg调试SQLSERVER的环境设置调试SQLSERVER (三)使用Windbg调试SQLSERVER的一些命令 我们知道调试程序主要有两种方法 一种是:live debugging (附加进程 使进程hang住) 生产环境最好不要live debugging 一种是:post-mortem debugging or reading dump files (生成dump文件然后进行分析) 现在介绍一