arcengine一书写作规范.docVIP

PAGE / NUMPAGES AE一书写作规范 目录 TOC \o 1-3 \h \z \u AE一书写作规范 1 1写作格式 1 1.1通篇注意点 1 1.2实例与数据路径介绍 3 2代码格式 3 2.1代码样式 3 2.2代码写作规范 3 3图格式 3 3.1截图格式 3 3.2图片大小格式 4 3.3图片题注规定 4 4表格式 4 4.1格式 4 4.2表格题注规定 4 5页面设置 5 6标题规定 5 附录：DotNet编程规范 5 A命名规范 5 B注释规范 7 C代码风格 8 D程序规范 9 E有关界面窗口问题 13 1写作格式 1.1通篇注意点 1）每章写作可根据情况在正文前写上本章的总起，如本章要讲的知识点、程序功能等，每章结束时要写本章小结。 2）程序运行截图需放在代码说明之前 3）章节无需再对控件命名进行介绍，如果控件命名包含设置控件的其他属性，若认为有必要，可酌情添加空间命名。 4）代码介绍时，应写成代码如下（详细代码位于本书随书光盘“…\Ch10\10_2\交通网络分析（部分）”）： 5）程序代码前，要加上程序实现基本思路。 6）如果实例操作较为复杂。可根据情况添加程序操作步骤，步骤格式统一按照（1）（2）（3）….的格式展开。 7）介绍截图，统一使用如图X.XX所示。对于有对比图出现的，图片题注应采用（a）.. （b）..这种格式。然后下面再有个总格式，例如： （ SEQ （ \* alphabetic a）网络中的边 （ SEQ （ \* alphabetic b）网络中的交汇点 图10. SEQ 图7. \* ARABIC 1网络中的边和交汇点示意图 8）如果本章只包1个或2个大的实例（2个以下sln运行程序），可在本章初引子里除介绍本章节内容外，给出程序运行的界面，好处在于可使读者在阅读本章前知道本章的编程对象是什么、有什么功能，从而带着兴趣阅读下文。 如果本章的程序多于2个（2个以上sln运行程序），则只需在本章初的引子里，给出本章包含内容,不必再给出程序运行界面（否则太多的运行界面就显得凌乱），可在余下正文中一一给出介绍。 如第五章开头： 第三章： 9）任何截图，请使用snagit，确保截图质量较高，手工绘制使用Visio 10)对于程序运行后自动加载数据的系统，不能将数据放入程序debug文件夹中，数据要和程序位于同级目录，如下图： 代码要使用相对路径去写，详细代码可参考第十章。 1.2实例与数据路径介绍 实例与数据放在同一文件夹下，例如第十章，可新建文件夹名为“Ch10”，若本章共3个实例，可分别在此文件夹下新建“10_1”“10_2”子文件夹，每个子文件夹下放入实例和数据data。 目录如下： 点开10_1 实例数据位于随书光盘“…\Chp10 \10_2\data\最近设施点分析\chapter10.mdb” 实例位于随书光盘中“…\Chp10 \10_1\最短路径分析。 2代码格式 2.1代码样式 代码使用小五，代码之间要不要留空行，字体采用 Times New Roman。 代码文字注释小五、宋体。注释使用//而不是/// 或////等其他形式 2.2代码写作规范 详见下文第二章附录“DotNet编程规范” 3图格式 3.1截图格式 1）书中用到的如等的图标，请使用中文帮助网站中提供的图标，请勿自己在ArcGIS上截图，这样不清晰。图标在网站中直接复制即可。 2) 撕裂图可以使用。只允许在下方撕裂。 3) 截图一律采用snagit软件，截图平台先在自己机器上截图，最后统一在一台机器上截图。 3.2图片大小格式 1）图片大小一般缩小为60%。可以在50%-60%之间选择。特别是分栏的图片或个别图片自己视情况而定===最后截图时要精确制定比如我记得我们好像是58%，以后再说 2）同一类型的图片要保持同样的大小，如两个同等级别的实例放在一起要统一大小。 3.3图片题注规定 1）图题注在图片下方；宋体、小五、居中；图片的题注下空一行（但下文为标题的例外）。 2）图题注都在word中的【插入题注】功能自动生成（如图 STYLEREF 1 \s 8. SEQ 图 \* ARABIC \s 1 45 报表向导对话框）注意上句号中“图 STYLEREF 1 \s 8. SEQ 图 \* ARABIC \s 1 45”与“报表向导对话框”之间有一个空格；正文中使用【交叉引用】功能（如图8.45所示），注意“如图8.45所示”字符中间不存在空格。8是章号，图片以章为单位进行顺序编号。正文不允许出现如下图所示等，要如图*.*所示。要使用引注！！