企业🤖AI智能体构建引擎,智能编排和调试,一键部署,支持私有化部署方案 广告
文档是一个团队开发中十分重要的部分;但是在一个开发者分享自己的代码给其他开发者的时候也是一个基本的需求,甚至打算重构代码,面对一个几个月前编写的没有文档的代码也是十分痛苦的事情。幸好,Haxe 提供了一个很好的工具,使用代码和代码的注释自动产生文档。 编译器在打开编译开关 -xml 生成一个 XML 文件,它包含完整的编译项目中的代码描述。 XML 包含从类定义到变量类型之间的方方面面的信息。此外,一些注释被保留,并方便的关联到它们描述的代码。要被包含进 XML 文件,注释必须是块类型的,使用两个星号到斜线后,而不是一个;所有不符合这个规则的注释都会被丢弃。作为一个例子,如下的 enum 已经被正确的提供文档级的注释。 ~~~ // fragment of file QueryTools.hx /** * A condition is a test to perform in the query. Many conditions can be * joined together using the “and” or “or” constructors. */ enum Condition { /** * Test if the passed field is Null. */ TestIsNull(field : String); /** * Test a numeric field against a value using a numeric operator. */ TestNumber(field : String, operator : NumericOp, value : Float); /** * Test a text field against a text value using a text operator. */ TestText(field : String, operator : TextOp, value : String); /** * Joins many conditions in a group. The group will evaluate to true if * all of its members evaluate to true. */ And(tests : Array < Condition > ); /** * Joins many conditions in a group. The group will evaluate to true if * at least one of its members evaluates to true. */ Or(tests : Array < Condition > ); } ~~~ 当通过下面的命令编译,一个 doc.xml 文件同时生成: ~~~ haxe -neko neko.n -xml doc.xml QueryTools ~~~ 现在,有两种选择生成一个可读的文档:使用 haxedoc 工具来生成离线文档,或者使用 haxedoc.n 字节码来创建在线文档。