Comment on groups of elements
749
Views
13
Comments
New
Service Studio

It would be great to have the possibility to comment on a group of elements.
And make it visually clear in the interface, which elements the comment effects.

In this way it's more clear which elements are part of the comment and as a bonus you can easier comment on large pieces of code.

In the same way comments are usually done in traditional coding, like (e.g. in javascript):

//Start of function / piece of code
/* Initialize and invoke a the greetUser function
to assign user's name to a constant and print out
a greeting. */

function greetUser() {
    const name = prompt("What is your name?");
    console.log("Hello ," + name + "! How are you?");
}

greetUser();

//Start of another function / piece of code
/* Initialize and invoke a the sayGoodbyeUser function
to print out a goodbye. */

......


Visual idea:




Great idea!!

Top

It is a bit crappy but you can not this already by just adding spaces and lines to a comment.

2016-04-22 00-29-45
Nuno Reis
 
MVP

I agree that sometimes actions get so huge that you need to visualize subsections. A big colorful box (like comment, but that also includes comments inside) to highlight blocks of logic.

Sometimes I do an empty comment (like Daniel mentions) as background to know they are together, but adding new elements moves everything and it gets harder to read.

The best approach, for now, is to connect the comment to the corresponding elements. Those extra lines make the diagram harder to read, but at least they don't disconnect.


Changed the category to
Service Studio
Merged this idea with 'Highlight/tag a section of code' (created on 20 Feb 2019 17:14:20 by Craig Duggan)

Rather than only having the post-it note type comments it would be really useful (particularly when collaborating with others on a project) to be able to select a whole section of code to comment on, maybe also be able to tag it with a searchable tag. 

This could be done by adding a subtle background colour behind the code with a tag/comment box linked to it.



This comment was:
- originally posted on idea 'Highlight/tag a section of code' (created on 20 Feb 2019 by Craig Duggan)
- merged to idea 'Comment on groups of elements' on 12 Feb 2021 06:52:47 by Daniël Kuhlmann
2014-02-07 17-02-43
Vasco Pessanha
Changed the category to
Collaboration


This comment was:
- originally posted on idea 'Highlight/tag a section of code' (created on 20 Feb 2019 by Craig Duggan)
- merged to idea 'Comment on groups of elements' on 12 Feb 2021 06:52:47 by Daniël Kuhlmann
Merged this idea with 'Ability to comment a block of code' (created on 11 Feb 2021 19:03:22 by Vitor Santiago)

It would be great if OutSystems could provide a way to comment on a block of code, just like any other programming language.

If we take a look at JavaScript comments, we could comment on a single line of code by just adding "//" and if we want to comment multi-lines of code we start with "/*" and end with "*/".

If we dig into the OutSystems visual language, we could understand that a single line comment could be obtained with the Comment widget but the multi-line concept is not covered.

I'll attach a print screen to support the idea.


Cheers, VS



This comment was:
- originally posted on idea 'Ability to comment a block of code' (created on 11 Feb 2021 by Vitor Santiago)
- merged to idea 'Comment on groups of elements' on 12 Feb 2021 06:54:15 by Daniël Kuhlmann

Perhaps we could even mix and match with this idea from Rebecca Hall:

https://www.outsystems.com/ideas/10074/color-code-comments



This comment was:
- originally posted on idea 'Ability to comment a block of code' (created on 11 Feb 2021 by Vitor Santiago)
- merged to idea 'Comment on groups of elements' on 12 Feb 2021 06:54:15 by Daniël Kuhlmann

Hi Victor,

Actually this idea exists already, so I will merge it into that one:
https://www.outsystems.com/ideas/7904/comment-on-groups-of-elements

Also the Idea from Rebecca already existed and is merged into the already existing idea.

Kind regards,

Daniel



This comment was:
- originally posted on idea 'Ability to comment a block of code' (created on 11 Feb 2021 by Vitor Santiago)
- merged to idea 'Comment on groups of elements' on 12 Feb 2021 06:54:15 by Daniël Kuhlmann

You know you can draw multiple arrows from the Comment to multiple items, right? To have it work exactly the way you want, right?

J.Ja