如何为所有用户定义的julia函数构建索引页面？

Question

说我有A.jl,B.jl,C.jl,D.jl.在每个.jl中,有100个函数.当我尝试调用特定函数时,我需要搜索.jl以确定函数是如何定义的？是否有一种简单的方法可以将所有函数定义生成到HTML索引页面中.如果我可以单击该链接并查看该函数的实际源代码,它会更好.像Doxygen那样为C/C++生成文档,但Doxygen不支持Julia.谢谢.

Answer 1

在我看来,对文档功能的内置支持实际上非常好.

1. 基本上你使用"docstrings":https://docs.julialang.org/en/stable/manual/documentation/#Documentation-1

   """
       s = mysum(a,b)
   
   Compute the sum of `a` and `b`.
   """
   function mysum(a,b)
       return a+b
   end
   

2. 将函数放在模块中可能很有用(A,B,C和D可以是单独的模块).您使用using A或加载模块import A(文件A.jl应该在您的文件中LOAD_PATH).如果使用,import该函数的前缀是以点分隔的模块名称.如果函数未在模块中分组,则需要包含包含函数的文件,例如include("A.jl")(使用完整路径或相对路径).

3. ?例如,?myfunction_in_module_A或者?A.myfunction_in_module_A在加载模块后,可以显示文档.

4. 如果您不记得功能名称

   • 你可以用全文搜索apropos("my keyword").
   • list all函数是一个模块 names(module_A)
   • 使用相关类型进行搜索 methodswith

5. Documenter.jl允许通过将所有docsstrings组合到单个HTML文档中来制作漂亮的文档.