F

---

SKILL IDE Document Generation

---

As a SKILL programmer, you may need to reuse the code written by other developers or provide your code to other developers for integration. When it comes to programming, documenting the details of the code is as important as the code itself. Since the code evolves over time, it is imperative that the documentation stays synchronized with the code. The best way to achieve this is to embed the documentation within the code.

SKILL IDE’s inline documentation capability allows you to embed documentation strings within SKILL/SKILL++ functions, classes, and methods. These documentation strings describe the attributes of the code elements with which they are associated. For example, the documentation string for a SKILL function may contain the description, parameters, and return values for the function.

SKILL IDE also has a document generation utility called Finder Manager, which inspects the code containing inline documentation and generates finder-compatible documentation from it.

Related Topics

Documentation-specific Code

Output Formatting

Extracting Documentation using Finder Manager

Viewing the Generated Documentation in Finder