Introduction to Comments and Documentation

Depending on the use of the created physics interfaces, the need for internal documentation (comments about implementation and for simplifying extending and maintaining the implementation) and external documentation (user documentation and context help) varies. The Physics Builder includes tools for creating documentation for both internal and external documentation. There are two main types of nodes that you can add to the physics interface and its features:

•

nodes, where you can add comments about each feature for internal use. Those comments can provide information about the implementation, its benefits and limitations, any remaining issues, or ideas for future extensions. You can add a node to each individual node in a physics interface, including the components that you use to create a physics interface feature (such as and nodes).

•

nodes, for creating end-user documentation, including context help for the physics interface and its features. For in-depth documentation, you can use various sections that add plain text, equations, images, lists, tables, references, and other documentation items to build a full documentation of the functionality, use, and theory behind the physics interface and its features.

The following sections provide details about how to add documentation to physics interfaces in the Physics Builder.