全球彩票平台_全球彩票注册平台|官网下载地址

热门关键词: 全球彩票平台,全球彩票注册平台,全球彩官网下载地址

【全球彩票平台】在VS2103环境中集成Doxygen工具,

留神:这里的x.y是本子号码,如当前版本号2.14;

二、工具简要介绍

doxygen:是一种从标志过的C 源代码生成文档的正统工具,也匡助C,Objective-C,C#,PHP,Java,Python,IDL,Fortran,VHDL,Tcl等。

graphviz:是一种开源的将结构化音讯展现成肤浅图和网络的工具,用于互连网,生物音信,软件工程,数据库和网址设计,机器学习以及别的技能世界的可视性接口。

3、编码时,遵照某种格式编写注释
4、生成对应文书档案

切切实实下载目录在 /2014年龄资历料/6月/25日/Linux下Doxygen的安装和利用/

1:Mac安装Brew

2 安装Graphviz

三、生成函数调用图

1、下载并设置以下二种工具

doxygen:(

graphviz:(

专心下载时,选取的是windows版本,照旧mac版本。

假若设置进程中弹出“打不开 XXX,因为它出自己份不明的开垦者”请走入如下网站搜索消除办法:

2、运维DoxyWizard,弹出Doxygen配置分界面

全球彩票平台 1

选用Scan recursively则递归分析源代码目录中的子目录内的源代码。

鉴于应用到了Graphviz,所以要安装Dot选项,勾选HAVE_DOT,并设置DOT_PATH为Graphviz的bin目录。(注意:MAC的Graphviz的bin目录不在安装包内,一般是在/usr/local/bin/,实在找不到就到终极用ls一层一层的搜寻)

除此以外,若Doxygen出现汉语乱码难题:

安装如下:

Expert选项卡-> Project:

DOXYFILE_ENCODING:UTF-8

OUTPUT_LANGUAGE:Chinese

Expert选项卡-> InPut:

INPUT_ENCODING:GB2312

与上述同类生就足以准确生成含有普通话的文书档案了。

原文:

连带阅读:

1、第叁遍选用须要设置doxygen的顺序

常用选项如下:

appledoc--output../doc--project-name weibo--project-company"wxhl"--company-id"com.wxhl.weibo".

1 安装doxygen

Doxgen就是响当当的文书档案生成工具,並且是免费开源的,它选用十三分便于,能提取C ,Java,Objective-C,Python,IDL,PHP,C#等语言的笺注,进而生成文书档案

3、doxygen 的笺注规范 

不要全体程序代码中的解说都会被Doxygen 所管理。您必得依据科学的格式撰写。原则上,Doxygen 仅管理与程序结构相关的讲明,如
Function,Class ,档案的演说等。对于Function内部的讲明则不做拍卖。Doxygen可处理上边两种档期的顺序的注明。

JavaDoc类型:

/**
 * ... 批注 ...
 */

Qt类型:

/*!
 * ... 批注 ...
 */

     
单行型式的注脚:

/// ... 批注 ...

或    

//! ... 批注 ...

    
  
要选拔哪个种类型态完全看本人的喜好。以小编本身的话,大面积的笺注小编会使用JavaDoc 型的。单行的讲授则选择"///" 的项目。

除此以外,由于Doxygen 对于批注是正是在解释前面包车型地铁程序代码。也正是说,任何几个批注都以在证实之后的程序代码。假使要批注前面包车型地铁程
式码则需用下边格式的解说符号。

/*!< ... 批注 ... */
/**< ... 批注 ... */
//!< ... 批注 ...
///< ... 批注 ...

    
地点那几个法子并不适用于任何地方,只好用在class 的member或是function的参数上。

比喻来说,若我们有上面那样的class。
    class MyClass {
        public:
            int member1 ;
            int member2:
            void member_function();
    };
    
累加讲解后,就改为那样:

    /**
     * 我的自订连串申明 ...
     */
    class MyClass {
        public:
            int member1 ; ///< 第一个member说明 ...
            int member2:  ///< 第二个member说明 ...
            int member_function(int a, int b);
    };
    
    /**
     * 自订类别的member_funtion说明 ...
     *
     * @param a 参数a的说明
     * @param b 参数b的说明
     *
     * @return 传回a b。
     */ 
    int MyClass::member_function( int a, int b ) 
    {
        return a b ;
    }
    
当你使用Doxygen 产生表明文书档案时,Doxygen 会帮你parsing 您的程式码。而且依据程序结构创设相应的文书。然后再将你的讲解,凭仗其岗位套入于科学的地点。您或者曾经注意到,除了一般文字表达外,还有局地任何特别的授命,疑似@param及@return 等。那就是Doxygen 其他三个注重的有的,因为三个类型或是函式其实都有一定多少个要证实的一部分。为了让Doxygen 能够看清,全部大家就必须使用那一个指令,来报告Doxygen 后边的讲授是在表达如李军西。Doxygen 在拍卖时,就能够帮您把那一个有些做极度的拍卖只怕排版。以致是制作参谋连结。
率先,我们先表达在Doxygen 中对于项目或是函数注脚的叁个特定格式。
    /**
     * class或function的粗略表达...
     *
     * class或function的详细表达...
     * ...
     */ 
地点那个事例要说的是,在Doxygen 管理叁个class 或是function表明时,会先决断第一作为归纳表达。这几个大致表达将一向到空一行的产出。或是蒙受第三个"." 截至。之后的疏解将会被视为详细表明。两个的差别在于Doxygen 在好几地点只会来得简易表明,而不呈现详细表明。如:class 或function的列表。

另一种比较清楚的措施是钦点@brief的授命。那将会刚烈的告诉Doxygen,何者是不难表达。举个例子:
    /**
     * @brief class或function的简约表明...
     *
     * class或function的事无巨细表达...
     * ...
     */

除开那一个class 及function外,Doxygen 也可针对档案做验证,条件是该批注需置于档案的先头。主要也是选择部分命令,平日这一部分表明都会放在档案的开始地点。如:

    /*! file myfile.h
        brief 档案简易表明
    
        详细表明.
        
        author 小编消息
    */

如你所见,档案批注约莫格式如上,请别被"" 所搞混。其实,"" 与"@" 都是一样的,都是报告Doxygen 前面是二个限令。三种在Doxygen 都可使用。作者本人相比偏心应用"@"。
随后大家来针对有的常用的指令做注明:

@file

档案的批注说明。

@author

作者的信息

@brief

用于class 或function的批注中,后面为class 或function的简易说明。

@param

格式为

@param arg_name 参数说明

主要用于函式说明中,后面接参数的名字,然后再接关于该参数的说明。

@return

后面接函数传回值的说明。用于function的批注中。说明该函数的传回值。

@retval

格式为

@retval value 传回值说明

主要用于函式说明中,说明特定传回值的意义。所以后面要先接一个传回值。然后在放该传回值的说明。

       
Doxygen 所补助的命令比较多,有个别以致是有关出口排版的主宰。您可从Doxygen的运用表明中找到详尽的求证。

上边大家希图一组example.h 及example.cpp 来注明Doxygen 演说的运用格局:

example.h:

    /**
     * @file 本榜样的include档案。
     *
     * 这几个档案只定义example那么些class。
     *
     * @author garylee@localhost
     */
            
    #define EXAMPLE_OK  0   ///< 定义EXAMPLE_OK的宏为0。
    
    /**
     * @brief Example class的粗略表明
     *
     * 本范例表明Example class。
     * 那是叁个极为简约的表率。
     * 
     */
    class Example {
        private:
            int var1 ; ///< 那是二个private的变数
        public:
            int var2 ; ///< 那是三个public的变数成员。
            int var3 ; ///< 那是另多少个public的变数成员。
            void ExFunc1(void); 
            int ExFunc2(int a, char b);
            char *ExFunc3(char *c) ;
    };
    
    
example.cpp:

    /**
     * @file 本轨范的程序代码档案。
     *
     * 这一个档案用来定义example那么些class的
     * member function。
     *
     * @author garylee@localhost
     */
    
    /**
     * @brief ExFunc1的粗略表达
     *
     * ExFunc1未有任何参数及传回值。
     */
    void Example::ExFunc1(void)
    {
        // empty funcion.
    }

    /**
     * @brief ExFunc2的简便表明
     *
     * ExFunc3()传回五个参数相加的值。
     *
     * @param a 用来相加的参数。
     * @param b 用来相加的参数。
     * @return 传回七个参数相加的结果。
     */
    int ExFunc2(int a, char b)
    {
        return (a b);
    }
    
    /**
     * @brief ExFunc3的粗略表明
     *
     * ExFunc3()只传回参数输入的指标。
     *
     * @param c 传进的字符指针。
     * @retval NULL 空字符串。
     * @retval !NULL 非空字符串。
     */
    char * ExFunc2(char * c)
    {
        return c;
    }    

 

全球彩票平台 2
 
三、配置使用
1、在品种工程目录下转移配置文件
cd test/            #步向项目目录(test为例表达)
Doxygen –g        #浮动配置文件
提示:
1、暗许生成的配备文件名叫"Doxyfile",也可以内定生成的布局文件名:doxygen -g your-cfg-filename
 
2、能够在调换配置文件的下令中加多 "-s" 选项,生成不含注释的配备文件:doxygen -sg
 
2、依照要求,修改配置文件
模板下载

开源框架: Appledoc

3 设置doxygen

你能够访谈其官网,下载安装包,它的官网络有详细的使用手册。

2、生成doxygen配置文件

无需付费下载地址在

--project-company "wxhl" 设置公司名称为“wxhl”

从此处下载

当分析贰个很复杂的门类源代码时,怎么样有效的分析函数间的调用关系吗?从网络检索到了如下方法:使用doxygen和graphviz来机关深入分析函数间的调用关系。

                   

# 项目名称,将用作于所生成的次序文书档案首页题目
PROJECT_NAME        = “Test”
# 文书档案版本号,可对应于项目版本号,举例 svn、cvs 所生成的花色版本号
PROJECT_NUMBER      = "1.0.0
# 程序文书档案输出目录
OUTPUT_DIRECTORY    =  /home/user1/docs
 
# 程序文书档案输入目录
INPUT                = /home/user1/project/kernel
 
# 程序文书档案语言情况
OUTPUT_LANGUAGE      = Chinese
 
# 只对头文件中的文书档案化新闻生成程序文书档案
FILE_PATTERNS        =
 
# 递归遍历当前目录的子目录,寻找被文书档案化的程序源文件
RECURSIVE            = YES
# 假设是成立 C 程序文档,该选用必须设为 YES,不然暗中同意生成 C 文书档案格式
OPTIMIZE_OUTPUT_FOR_C  = YES
 
#领取新闻,满含类的私有数据成员和静态成员
EXTRACT_ALL            = yes
EXTRACT_PRIVATE        = yes
EXTRACT_STATIC        = yes
# 对于利用 typedef 定义的结构体、枚举、联合等数据类型,只依照 typedef 定义的项目名进行理文件书档案化
TYPEDEF_HIDES_STRUCT  = YES
# 在 C 程序文书档案中,该值能够安装为 NO,而在 C 程序文书档案中,由于 C 语言未有所谓的域/名字空间那样的定义,所以那边安装为 YES
HIDE_SCOPE_NAMES      = YES
# 让 doxygen 静悄悄地为你转移文档,唯有出现警示或错误时,才在终端输出提醒新闻
QUIET  = YES
# 递归遍历示例程序目录的子目录,寻觅被文档化的程序源文件
EXAMPLE_RECURSIVE      = YES
# 允许程序文书档案中呈现本文书档案化的函数互相调用关系
REFERENCED_BY_RELATION = YES
REFERENCES_RELATION    = YES
REFERENCES_LINK_SOURCE = YES
# 不生成 latex 格式的主次文书档案
GENERATE_LATEX        = NO
# 在程序文书档案中允许以图例情势显得函数调用关系,前提是您曾经安装了 graphviz 软件包
HAVE_DOT              = YES
CALL_GRAPH            = YES
CALLER_GRAPH          = YES
#在终极生成的文书档案中,把全数的源代码富含在其间
SOURCE BROWSER        = YES
$那会在HTML文书档案中,增添一个侧面栏,并以树状结构彰显包、类、接口等的关联
GENERATE TREEVIEW      = ALL
 
3、程序注释文书档案化
行使Doxygen,要求遵从Doxygen 的游戏准绳来对前后相继源码进行文书档案化。
Doxygen 的笺注类型可分为:
1、行间注释:注释语句不与程序源码出现在一直以来行,重要用于注释头文件中冒出的布局体 (struct)、枚举 (enum)、联合 (uion) 等数据类型,以及程序接口的功用与利用约定;
2、行内注释:注释语句与程序源码出现在一样行内,主要用来代码的片段注释。
详见语法参照他事他说加以考察:
 
4、文书档案生成
cd test/
doxygen
提示:
能够指虞诩顿文件名:doxygen  your-cfg-filename

对此风靡版本的appledoc来讲,它默许时是生成docset文档并集成到xcode,当必要html文档时,可以增多"--no-create-docset"

4 编译 cocos2d-documentation 项目

       Doxygen 是一个先后的文本发出工具,可将先后中的特定解说转变到为表达文件。常常我们在写程序时,或多或少都会写上注脚,可是对于其余名来讲,要一贯追究程序里的讲解,与打捞铁达尼号一样的劳动。超越伍分叁一蹴而就的证明都以属于针对函式,体系等等的表达。所以,借使能依照程序本人的布局,将讲授经过管理重新整理成为二个从头到尾的参谋手册,对于背后利用你的程序代码的人来说将会降低过多的担负。可是,反过来讲,整理文件的行事对于你来讲,正是致命的肩负。Doxygen 就是在您写解说时,稍微依照一些它所制订的条条框框。接着,他就足以帮您发出出完美的文书档案了。据此,Doxygen 的利用可分为两大学一年级些。首先是特定格式的讲解撰写,第二正是选取Doxygen的工具来产生文档。

全球彩票平台 3
 
5、文书档案使用
转换的文书档案位于test/doc/html 目录中,使用浏览器展开该目录中的 index.html 文件,就能够看出自个儿的行事成果。

http://blog.devtang.com/blog/2012/02/01/use-appledoc-to-generate-xcode-doc/

最终,在XCode的Help菜单下,展开Documentation and API Reference,就能够看出多了一项Cocos2D文书档案了。

1、安装doxygen及其相关程序

1.1Doxygen下载

实行下载

正文使用的为Doxygen 1.8.3.1

设置,大家就要配备的时候利用doxywizard,Doxygen的GUI版本。

1.2HTML Help Workshop下载

倘使您愿意您的Doxygen自动生成chm,那么请下载HTML Help Workshop,大家就要接纳当中的hcc.exe文件以及有关dll

进行下载

下载个中的htmlhelp.exe并安装,记住安装目录,大家将要Doxygen配置时采用。

1.3 Graphviz

graphviz 是二个由AT&T实验室开发银行的开源工具包,用于绘制DOT语言脚本描述的图形。Doxygen 使用 graphviz 自动生成类之间和文书之间的调用关系图,如不须求此意义可不安装该工具包。

设置并记录安装目录,同样大家一会内需配置Doxygen

 具体的效力是底下的:饱含怎么生产Doxygen

      首先在网络下载Doxygen,HTML Help Workshop。那七个软件直接在分级的官网络下载就行了。

      然后选用doxywizard.exe生成一个Doxygen文件。点击“D:program filesDoxygendoxygenbindoxywizard.exe”出现如下分界面:在Wizard属性页首要必要改一个地方,点击右边包车型客车“Output”将左侧复选框中的LaTex中的钩去掉;然后在Step1:上面钦赐Doxygen的办事目录,正是其一向导生成的公文的存放路线。

全球彩票平台 4

      在"Wizard"和“Export”中还应该有相当多年足球以编写制定的参数,一时不修改,以往熟稔了再改。然后点击“Run”上边包车型大巴“Run doxygen”就足以生成了剧本。

全球彩票平台 5

      再点击“File”菜单中的"Save as",就能够生成我们须要的台本了,将转移的本子命名字为default.doxygen如图:

全球彩票平台 6

全球彩票平台 7

      default.doxygen就是不足为奇的公文文件,在此间供给对它实行一些编辑,这几个须求编制的地点重大是字符编码的主题素材,其实在头里的图纸化分界面中也足以举办更动的。

要害必要修改的地点有如下几处:

 

GENERATE_HTMLHELP      = YES

OUTPUT_LANGUAGE        = Chinese

CHM_INDEX_ENCODING = gb2312

DOXYFILE_ENCODING=gb2312

INPUT_ENCODING=gb2312

接下来那个default.doxygen就管理好了。

接下去是在vs中如胶似漆那个工具方便现在使用了。将default.doxygen拷贝到必要改换文书档案的工程上面

1.集成Doxygen

在VS环境中:Tools->External Tools->Add

Title: Doxygen

Command: D:Program Filesdoxygenbindoxygen.exe(doxygen的装置目录)

Arguments: $(ProjectDir)default.doxygen

Initial directory: $(ProjectDir)

(能够把use output window复选框勾上)

 

点击Tools->Doxygen,将会在工程目录下生成html文件夹,里面包车型地铁html文件正是自动生成的注释文件。

 

2.集成CHM制作工具HTML Help Workshop

首先安装HTML Help Workshop。

 

在VS环境中:Tools->External Tools->Add

Title: HTML Help Workshop

Command: D:program filesDoxygenhtmlhelphhw.exe(HHW的安装目录)

Arguments: $(ProjectDir)htmlindex.hhp

Initial directory: $(ProjectDir)

点击Tools->HTML Help Workshop,就能够出现HHW的窗体,编写翻译,可获得index.chm文件。

只顾:编写翻译时,会弹出一个窗口确认路线名,而VS自动传入的门径名是有错误的,多了2个双引号,去掉双引号,编写翻译,就足以成功了。如下图:

全球彩票平台 8

 3.集成CHM文件查看工具hh.exe

在VS环境中:Tools->External Tools->Add

Title: ViewCHM

Command: C:WINDOWShh.exe(windows自带)

Arguments: $(ProjectDir)htmlindex.chm

Initial directory:

点击Tools-> ViewCHM,就能够看到index.chm文件了。 

 

假如倘诺Html的讲授,应该不要安装前边的四个了!

全球彩票平台 9

//Doany additional setup after loading the view,typicallyfroma nib.

接下来点击安装。安装文件会安装到/usr/local/graphviz-x.y/bin目录中。

投机已将学习了两一遍了吧,大致这一次该总计一下:

顾客名与密码都以www.linuxidc.com

git clone git://github.com/tomaz/appledoc.git

双击Doxygen.dmg,出现二个窗口,拖动DoxygenLogo到Mac系统的/Applications目录下最注重一步);

                    

一、简介
Doxygen是一种开源跨平台的,以看似JavaDoc风格描述的文书档案系统,完全匡助C、C 、Java、Objective-C和IDL语言,部分帮助PHP、C#。注释的语法与Qt-Doc、KDoc和JavaDoc包容。Doxgen能够从一套归档源文件开始,生成HTML格式的在线类浏览器,或离线的LATEX、RTF参谋手册。
 
二、安装
需安装doxygen和用来援救doxygen的图像化学工业具graphviz,步骤如下:
 
1、安装doxygen
1、财富下载:doxygen-1.7.4.linux.bin.tar.gz

2、编写翻译安装
1)  tar xvfz doxygen-1.7.4.linux.bin.tar.gz
2)  cd doxygen-1.7.4
3)  ./configure
4)  make
5)  make install
 
2、安装graphviz
1、实践如下命令就可以成功安装
yum install graphviz

appledoc--no-create-docset--output../doc--project-name weibo--project-company"wxhl"--company-id"com.wxhl.weibo".

小结:详解在XCode4Cocos2D-1.0.0文书档案集成的情节介绍完了,希望本文对你富有扶助!

 

下载格局见 http://www.linuxidc.com/Linux/2013-07/87684.htm

cd/Users/renrenyichun/appledoc

跻身cocos2d-iphone-1.0.0索引,修改该目录下的doxygen.config文件,将HAVE_DOT设置成YES,将DOT_PATH设置成/usr/local/graphviz-x.y/bin

 

------------------------------------------分割线------------------------------------------

3.设置:appledoc的Github托管地址如下:

本文由全球彩票平台发布于全球彩票平台操作系统,转载请注明出处:【全球彩票平台】在VS2103环境中集成Doxygen工具,

TAG标签: 全球彩票平台
Ctrl+D 将本页面保存为书签,全面了解最新资讯,方便快捷。