背景 这一块的内容更多的是作为了解,但是可以以这样的规范作为自己的编程注释习惯,提高自己的软实力. Doxygen注释语法 注释格式 块注释建议统一使用 /** -- ***/ 行注释建议统一使用 ///< - /** -- */ Doxygen常用注释命令 @exception <exception-object> {exception description} 对一个异常对象进行注释. @warning {warning message } 一些需要注意的事情 @todo { thi

近段时间,一直在学习华为C语言编程规范(2011版),在“注释”这一章中发现了一种“Doxygen”的注释转文档工具,查看诸多相关资料,并进行编程实践,终于可以利用Doxygen给C程序生成注释文档.在使用过程中,我已经深深地喜欢Doxygen,并在写代码时使用Javadoc注释风格. 本文由三部分组成:1)工具下载及安装:2)编写Doxygen可识别的注释:3)利用Doxygen工具将注释转换成API文档. 1.工具下载及安装 (1)Doxygen可以从一套源文件开始,生成HTML格式的在线类

Doxygen是一个 C++.C.Java.Objective-C.Python.IDL(CORBA和Microsoft flavors).Fortran.VHDL.PHP.C#和D语言的文檔生成器.可以在大多数类Unix的系统上执行,以及Mac OS X操作系统和Microsoft Windows.初始版本的Doxygen使用了一些旧版本DOC++的源代码:随后,Doxygen源代码由Dimitri van Heesch重写. Doxygen是一个编写软件参考文檔的工具.该文檔是直接写在源代码

//commndline: doxygen Doxyfile /**comment /* /** time diff@pre precondition@post endcondition@throw exceptions @param start The start time 参数 @param end The end time @returns timespec a number 返回值 */ timespec diff(timespec start, timespec end) {} 复用D

Doxygen是一种开源跨平台的,以类似JavaDoc风格描述的文档系统,完全支持C.C++.Java.Objective-C和IDL语言,部分支持PHP.C#.注释的语法与Qt-Doc.KDoc和JavaDoc兼容.Doxgen可以从一套归档源文件开始,生成HTML格式的在线类浏览器,或离线的LATEX.RTF参考手册. Doxygen 是一个程序的文件产生工具,可将程序中的特定批注转换成为说明文件.通常我们在写程序时,或多或少都会写上批注,但是对于其它人而言,要直接探索程序里的批注,与打捞铁

前言 下面主要讲解linux下Doxygen命令行实现html文档生成的操作,当然也有界面版本操作方式,linux下安装doxygen-gui即可通过doxywizard开启界面操作,windows下也可以通过doxywizard.exe界面进行配置操作,具体的界面操作请参考其他网上文章,不过有一句话需要说明:会命令行操作的,应该都会界面操作,而会界面操作的就不一定会命令行操作了. windows下的操作方式可以参考 使用doxygen生成chm范例 doxygen是什么 按照约定的格式注释源代

1.Doxygen简介 Doxygen是一个程序的文档产生工具,可以将程序中的注释转换成说明文档或者说是API参考手册,从而减少程序员整理文档的时间.当然这里程序中的注释需要遵循一定的规则书写,才能让Doxygen识别和转化. 目前Doxygen可处理的程序语言包含C/C++.Java.Objective-C.IDL等,可产生出来的文档格式有HTML.XML.LaTeX.RTF等,此外还可衍生出不少其它格式,如HTML可以打包成CHM格式,而LaTeX可以通过一些工具产生出PS或是PDF文档等.

今天板子刚到,新建的第一个工程就报错了. .\Objects\cse.sct(7): error: L6236E: No section matches selector - no section to be FIRST/LAST. 网上查了一下说什么启动文件没添加,可是他们都没说在哪添加启动文件,我第一次搞这个我也不知道. 这时我在stackoverflow里搜到了这个问题. 题主遇到的问题和我遇到的一样,然后下边有答主这样说: --------------------------------

一,效果图. 二,工程图. 三,代码. RootViewController.h #import <UIKit/UIKit.h> @interface RootViewController : UIViewController <UITableViewDataSource,UITableViewDelegate> { UITableView *mTableView; } @end RootViewController.m #import "RootViewControll

查看linux内核源码,你会发现有很多if (likely(""))...及if (unlikely(""))...语句,这些语句其实是编译器的一种优化方式,具体分析如下: likely及unlikely是一个宏定义: #define likely(x)  __builtin_expect(!!(x), 1) #define unlikely(x)  __builtin_expect(!!(x), 0) likely()的 意思是认为这个分支最有可能发生,如if (

接触Doxygen后,认识到其强大之处,一口气将之前的烂代码重构了一遍,所有的文件头,函数注释等等都是手动添加注释.在keil中可以看到其对JavaDoc风格的注释有高亮,非常好看.但是keil这个IDE作为编译器和调试工具,好用的没话说,作为编辑器却非常不能与时俱进.自动补全,代码缩进都超烂.找了很多编辑器,像sublime,Atom,VS code等,又缺少跨文件的补全,go to definition等功能.vim和emacs学习曲线又太长.同事提到可以试试Qt Creator看看,于是我

最近正在学习html5,刚接触html5,感觉有点不适应,因为有一些标签改变了,特别是div, section article这三个标签,查了一些资料,也试着用html5和css3布局网页,稍微有点头绪了,下边还有一个我刚刚布局好的一个简单的网页,供大家参考,先看一下,最起码心里对html5的结构有些概念. div HTML Spec: “The div element has no special meaning at all.” 这个标签是我们见得最多.用得最多的一个标签.本身没有任何语义,

Windows下使用doxygen阅读和分析C/C++代码 转自:http://blog.sina.com.cn/s/blog_63d902570100gwk6.html 虽然使用各种IDE或者Source Insight 可以方便地在windows下阅读和分析C/C++代码,但是一步步Go to Definetion 实在令人痛苦.Doxygen能够生成函数调用关系图,所有的函数调用关系可以一目了然,另外他还能统计文档中所有的类,成员变量,成员函数等.总的来说,Doxygen不但能从局部把握代

概括的讲,View中的内容可以分为静态和动态两部分.静态内容一般是html元素,而动态内容指的是在应用程序运行的时候动态创建的内容.给View添加动态内容的方式可归纳为下面几种: Inline code,小的代码片段,如 if 和 foreach 语句. Html helper方法,用来生成单个或多个HTML元素,如view model.ViewBag等. Section,在指定的位置插入创建好的一部分内容. Partial view,存在于一个单独的视图文件中,作为子内容可在多个视图中共享.

$\LaTeX$系列根目录: Latex学习笔记-序 IEEE模板中Section的编号是罗马数字,要是改投其他刊物的话可能得用阿拉伯数字,所以可以在导言部分做如下修改(放在导言区宏包调用之后): \renewcommand\thesection{\arabic{section}} %arabic 阿拉伯数字 %roman 小写的罗马数字 %Roman 大写的罗马数字 %alph 小写字母 %Alph 大写字母 同样的,也可以修改子目录的编号方式,而且各目录编号方式可以不同 \renewcomm

[DOM Event Learning] Section 4 事件分发和DOM事件流 事件分发机制: event dispatch mechanism. 事件流(event flow)描述了事件对象在数据结构中是如何传播的.   传播路径 事件对象(event objects)被分发给事件目标(event target),在分发开始的时候,在实现中必须先确定事件对象的传播路径. 这个传播路径必须是一个有序的list,其中包含了事件对象必须通过的事件目标.   对于DOM的实现来说,这个传播路径必

[DOM Event Learning] Section 3 jQuery事件处理基础 on(),off()和one()方法使用   jQuery提供了简单的方法来向选择器(对应页面上的元素)绑定事件处理器(event handlers). 当一个事件发生,提供的function就被执行,在方法里面,this代表当前的元素. 这些事件通常是由于用户和页面的交互而被激发,比如文字输入到表单元素,鼠标指针移动等.也有一些情况,比如页面load和unload的事件,是由浏览器本身来激发. 关于Even

[DOM Event Learning] Section 2 概念梳理 什么是事件 DOM Event   事件 事件(Event)是用来通知代码,一些有趣的事情发生了. 每一个Event都会被一个Event对象所表示,这个对象可能还会有一些自定义的字段或者方法,来获取发生什么事情的更多信息. Event对象实现了Event接口(https://developer.mozilla.org/en-US/docs/Web/API/Event).   事件可以是任何事情,从最基本的用户交互,到rend

[DOM Event Learning] Section 1 DOM Event处理器绑定的几种方法   网页中经常需要处理各种事件,通常的做法是绑定listener对事件进行监听,当事件发生后进行一些特定处理. 监听事件的几种方法如下文.   第一种,写在页面标签里面 <button onclick="alert('Hello')">Say hello</button> 上面这行代码,将按钮点击后的弹窗操作在标签声明的时候就绑定了. 这是一种糟糕的方法,原因如

Configuration Section Designer 简称 CSD 下载及英文介绍地址点击我 以下为简单使用说明 选择自己需要的版本安装好该设计插件之后重启vs 新建选择 在工具栏里选择想使用的工具 拖转添加 在属性里关联配置节点类型等 (别忘了命名空间) 如果配置不正确 可根据错误提示做相应的修改 自动生成的代码 调用事例