How to add comments to your Codeblock logic in Informed Design for Inventor

[#1]

Informed Design enables building product manufacturers to publish configurable manufacturing models, in turn making it possible for architectural designers to configure, generate, and insert those models as loadable Revit families directly into their Revit projects.

The Informed Design for Inventor Product Definition editor allows publishers to add logic using Codeblocks to ensure that all inputs result in manufacturable variants.

In this article, we’ll learn how to add comments in the Codeblocks workspace of a Product definition to document your code and communicate your intent.

Why should we add comments to our Informed Design Codeblock logic?

Why should I add comments to my code?

Adding comments to your code is a good way to communicate the thinking behind the code. This can be invaluable when editing the code or diagnosing issues.

You never know; it might be YOU who has to edit the code in three months' time… will you remember what you were thinking!

Adding inline comments with the comment Codeblock

To add a comment using the comment Codeblock:

1. From the Codeblocks library, select the Parameters category.
2. Select the 'Comment here' Codeblock and drag it onto the canvas.
3. Replace the text 'Comment here' with your comment.

Note: The number of characters in your comment is not limited, but only the first 50 characters will be displayed. Characters beyond 50  will be truncated with an ellipses (three dots '...').

Autodesk Informed Design codeblocks: Commenting your code.

Click here to visit the Autodesk Informed Design help entry for comment codeblocks

Adding comments to individual blocks

To add a comment to any Codeblock:

1. Select the Codeblock with a Left click, then right mouse button click and select ‘Add comment’ from the options.
2. A question mark symbol will appear. Click the symbol and the comment box will appear.
3. Click into the comment box and add your comment.
4. (Optional) The comment box can be moved by dragging on its border or resized by dragging the handle in the lower right of the border.
5. (Optional) To remove a comment, right mouse button click and choose ‘Remove comment’ from the options.

Note: The comment will remain visible until you click on the question mark symbol again.

Autodesk Informed Design codeblocks: Commenting on individual codeblocks.

How will you use comments in your Codeblock rules?

Codeblocks in Informed Design provide a flexible and intuitive way to define Product configuration options and limits and provide feedback to your Revit customers as they configure and place your product variants.

Click here for more information on codeblock best practices.