To aid consuming apps downstream, documentation is a major benefit. Until now, it was a large manual process to create and keep that in sync with app changes, unless the publisher invested in automation themselves.
For extension publishers, we provide a new ALDoc tool.
The ALDoc tool generates documentation from symbolic and syntactical information, code comments, and overall application structure based on input .app files. You can use it to generate internally or externally facing reference documentation for your solution.
The tool also generates a help site with the reference articles, sorted by the application structure, based on the provided custom template.
Generating content based on source code has many advantages such as accuracy, 100% reflection of the current codebase, less error prone documentation, and it saves time. The ALDoc tool generates documentation from symbolic and syntactical information, code comments, and overall application structure based on input .app files. The tool also generates a help site with these reference articles, sorted by the application structure, based on the provided template.
This article describes the necessary steps to use the ALDoc tool to generate the documentation for AL .app packages. The ALDoc tool relies on the DocFx tool, and needs the DocFx prerequisites to be available on the machine that generates the reference documentation.
g add
