← All ideas
  • Published 30 Sep 2021

Comment node

It would be helpful to have a Comment node that could be placed anywhere where we could enter text explaining what the node tree is doing. Like you comment computer code. Complex trees are often hard to follow so comments interspersed throughout would help explain what is going on.

97.1%

Development Status: Open

Upvote 34 Downvote 1
glenn1
30 Sep 2021

8 Comments

glenn1 Author

I had in mind a node you could place anywhere, just like any other node. You enter text and it has no connections.

2
brian4

I've been using multiple one-line frames as comments in my blender files. This is time-consuming and awkward but I'm absolutely committed to commenting my code. After 40+ years of coding, I accept the truth about my memory. Comments are so important for re-educating myself quickly.

Commenting can also be done by adding a frame and n to open the side panel, click on the node tab to modify the node, open properties, and then choosing a named comment created in the text editor, then manually resizing the frame to fit the text, but that is also very awkward. I'd rather use one-line frames.

It would be so much easier if the title of a frame could just be multi line. Or a special comment node was added for this purpose. Thank you!

1
Blueberry_pie

This sums up my feelings quite well. I usually prefer the text editor option, but it's quite awkward like you said. For me, the main struggle is the time and effort that's involved with switching between editors and then having to find the text data-block that I've just created or want to edit.

My proposal would be to make the frame node's Text property support inline adding (rather than just a selection dropdown):

UI mockup with Add button when no text is selected

Along with a small docked text editor when a text data-block is added/selected:

UI mockup with docked text editor when text is selected

It'd also be useful to have additional options for how the text is displayed in the frame node, e.g. choosing how the text should be aligned, whether it should wrap and/or whether it should be auto-sized to fit the node (or vice versa).

You can use Add -> Layout -> Reroute for this, and give it a label text through the properties or by pressing F2. :)

brian4

This is limited to a single line comment, which is the main problem.

Tabbes

You mean something like this?: blendernation.com/2015/09/08/add-on-text-notes-in-node-editor/ You can use "Add -> Layout -> Frame" with a Text selected in the Properties.

softyoda

Agree, on that solution, but just to add proposal to this thread, having an option to directly type comment in the N pannel properties of the selected frame (instead of opening a new text in the text editor) would be faster.

mrlegoboy

you can just type into the title of the frame