Torque2D MIT 学习笔记(22) 自己编译查询手册

前言

　　学习一种新的开发工具时,随之而来的是一套新的API,越是庞大,完善的工具库API越多,一份完整,实时更新的开发手册非常重要.

　　Torque2D不仅仅是套完善的库,还有自己专属的脚本语言TorqueScript,而且每天都在更新,如果没有一本好的手册,那么对于初学者将是很大的阻碍.

　　好在设计者在这方面很重视,在接口设计的时候就已经考虑到了动态生成手册的问题,如果你有一个Torque的执行文件,那么你就可以随时导出他的帮助手册.

问题

　　在tools\documentation\目录下面有生成帮助手册的批处理,手册有两种格式,一种网页版,一种CHM格式.

　　如果要生成CHM,需要在scriptReference.Windows.cfg文件中将GENERATE_HTMLHELP设置为YES.

　　如果你是SVN同步下来的工程,那么执行BAT应该就可以生成出CHM(我没有试过).但是如果你是用GIT同步下来的话,那么只能得到网页,不能生成SVN,解决方法也很简单.

解决

　　打开命令行,按照下面的输入:

　　G:\TorqueGit\tools\documentation>hhc G:\TorqueGit\tools\documentation\output\html\index.hhp
　　Microsoft HTML Help Compiler 4.74.8702

　　Compiling g:\TorqueGit\tools\documentation\output\html\Torque 2D - Script Reference.chm

　　Compile time: 0 minutes, 24 seconds
　　5,502   Topics
　　75,186  Local links
　　358     Internet links
　　0       Graphics

　　在Html目录里面便会有一个Torque 2D - Script Reference.chm文件,在每一次有大更新的时候,你都可以重新生成一次帮助手册~ :)