Documentation D支持文档生成吗?
许多现代编程语言支持注释系统作为文档字符串 在Python或Clojure等语言中,此功能被认为是理所当然的,在这些语言中,文档字符串可能有助于理解可能不清楚的函数的用途:Documentation D支持文档生成吗?,documentation,d,Documentation,D,许多现代编程语言支持注释系统作为文档字符串 在Python或Clojure等语言中,此功能被认为是理所当然的,在这些语言中,文档字符串可能有助于理解可能不清楚的函数的用途: def gen_ast(s): ''' given a string, s, representing a program, generates object model of abstract syntax tree ''' # function contents here ... 我是D编程的新手,但还
def gen_ast(s):
''' given a string, s, representing a program, generates object model of abstract syntax tree '''
# function contents here ...
我是D编程的新手,但还没有找到以客户端可以访问的方式编写文档字符串注释的文档(例如Python中的help(gen_ast)
)D是否提供对文档字符串的支持?是
对于代码本身:
对于命令行上的选项:
要从代码中获取:
但是,可以直言不讳地说,文档注释不能直接在代码中访问——您必须将其作为UDA或getopt库文档字符串来访问,或者在构建集中使用单独的命令来提取注释(dmd-D将它们转换为html,dmd-D-X将它们转换为json,然后您对其进行解析)作为@Adam D Ruppe回答的后续内容,以下是从第一个链接中提取的相关内容,这是D文档生成的官方规范 首先,返回函数的,具体如下:
/**
* Read the file.
* Returns: The contents of the file.
*/
void[] readFile(char[] filename) { ... }
其次,在需要时,以类似的方式指定示例:
/**
* Examples:
* --------------------
* writeln("3"); // writes '3' to stdout
* --------------------
*/
但是,我发现文档在使用这些约定自动生成文档的能力方面还不清楚。关于编译语言中help()的无关性,这是一个很好的观点。。。我仍然在适应没有依靠的生活。