Comment vs. Note

Discussions about systems engineering product SysML functionalities

Moderator: Moderators

Comment vs. Note

Postby christophe.waterplas@incose.org » Sun Aug 10, 2014 8:04 pm

Hello,

MagicDraw provides Notes and Comments which can both be attached to model elements. What are the differences between these two? When to use a Note and when to use a Comment?

Regards,
Christophe.
christophe.waterplas@incose.org
Forum Newbie
Forum Newbie
 
Posts: 11
Posts Rating:1
Joined: Sun Aug 10, 2014 8:00 pm

Re: Comment vs. Note

Postby ieva.n » Wed Aug 13, 2014 1:20 am

Hello Christophe,

A comment is a textual annotation that can be attached to a set of Elements. It is an UML element defined in UML specification, can exist without diagram and be created directly from model browser. One comment can be reused in several diagrams. It can be found in the model using Search even if it is not placed in diagram. As comments are elements, their text can be used in reports.
A note is a graphical symbol containing textual information. It is not an element. It is used to add any explanatory information needed for your element or diagram, or if user needs to display element properties not displayed on element shape. A note is usually connected to the element symbol using an anchor line.
A note can be attached to comment and represent its information in more details.
We advice to use Note when you want to display annotated element documentation, properties (e.g. hyperlink) on simply comment on diagram (e.g. note to yourself to clarify some details for specific element later), but you do not need this information in report and you do not need this information in other diagram. If you want to include the annotating information into report, annotate element not in browser, or reuse the information in other diagram (for example, if it is some note for all modelers working with specific element), you need to use Comment.

Kind regards,
No Magic Customer Support
ieva.n
No Magic
No Magic
 
Posts: 362
Posts Rating:28
Joined: Thu Aug 02, 2012 5:02 am
Full name: Ieva

Re: Comment vs. Note

Postby 543SysML » Tue Oct 31, 2017 8:44 am

What is a possible way of listing comments Anchored(attached/linked/connected) to an element? My usecase is to show comments anchored to requirement elements.
543SysML
Forum Newbie
Forum Newbie
 
Posts: 19
Posts Rating:1
Joined: Thu Apr 13, 2017 1:00 pm

Re: Comment vs. Note

Postby ieva.n » Tue Oct 31, 2017 8:59 am

Hello,

Yes, it is possible, if the comments are connected with anchor to requirements. If you are performing this from requirements table, perform the following steps:
1. Go to Show Columns > New Custom Column
2. In Query dialog click the Expert button at the bottom left to switch to expert mode
3. Select Metachain Navigation and create the new line
4. For first column select Requirement (it is set by default), in second column choose _commentOfAnnotatedElement
5. Create one more line and in first column choose Comment (it is set by default from first line), and in second column select Body.
6. Name the column and submit changes.

If you are trying to get comments from different situation, please attach the sample project.

Best regards,
No Magic, Inc. Customer Support
ieva.n
No Magic
No Magic
 
Posts: 362
Posts Rating:28
Joined: Thu Aug 02, 2012 5:02 am
Full name: Ieva

Re: Comment vs. Note

Postby 543SysML » Thu Feb 08, 2018 7:31 pm

Is there a way to combine Annotated Comments and Owned Comments together. I have attempted a Union but the results do not seem to show up in the custom column.
543SysML
Forum Newbie
Forum Newbie
 
Posts: 19
Posts Rating:1
Joined: Thu Apr 13, 2017 1:00 pm

Re: Comment vs. Note

Postby ieva.n » Fri Feb 09, 2018 10:09 am

Hello,

Could you please attach the project with "annotated comments" and "comments"?

Sincerely,
No Magic, Inc. Customer Support
ieva.n
No Magic
No Magic
 
Posts: 362
Posts Rating:28
Joined: Thu Aug 02, 2012 5:02 am
Full name: Ieva

Re: Comment vs. Note

Postby 543SysML » Fri Feb 09, 2018 6:24 pm

please see the table on the "model" diagram
You do not have the required permissions to view the files attached to this post.
543SysML
Forum Newbie
Forum Newbie
 
Posts: 19
Posts Rating:1
Joined: Thu Apr 13, 2017 1:00 pm

Re: Comment vs. Note

Postby ieva.n » Mon Feb 12, 2018 5:05 pm

Hello,

In this case the issue is that you try to get different element types. To display both comment types in one column, please remove the second line in metachain you have created (under column Annotated Elements) and change the element Type at the top to "Comment" (currently it is String).

Best regards,
No Magic, Inc. Customer Support
ieva.n
No Magic
No Magic
 
Posts: 362
Posts Rating:28
Joined: Thu Aug 02, 2012 5:02 am
Full name: Ieva

Re: Comment vs. Note

Postby ikechi.emelogu@ge.com » Wed Mar 28, 2018 1:59 pm

ieva.n wrote:Hello,

Yes, it is possible, if the comments are connected with anchor to requirements. If you are performing this from requirements table, perform the following steps:
1. Go to Show Columns > New Custom Column
2. In Query dialog click the Expert button at the bottom left to switch to expert mode
3. Select Metachain Navigation and create the new line
4. For first column select Requirement (it is set by default), in second column choose _commentOfAnnotatedElement
5. Create one more line and in first column choose Comment (it is set by default from first line), and in second column select Body.
6. Name the column and submit changes.

If you are trying to get comments from different situation, please attach the sample project.

Best regards,
No Magic, Inc. Customer Support


Can I use the quoted approach to show custom tags created for comments?

I applied a custom stereotype to my comments, so I could add more fields for review purposes (e.g. state of review, disposition, verified, etc). They are basically strings.

Thanks
ikechi.emelogu@ge.com
Forum Newbie
Forum Newbie
 
Posts: 4
Posts Rating:0
Joined: Thu Nov 30, 2017 4:07 pm

Re: Comment vs. Note

Postby ieva.n » Wed Mar 28, 2018 2:34 pm

Hello,

It should be possible to get the tags or other information. However, in some cases it might require scripting. If you could post your sample project here and let us know what exactly are you trying to achieve, we could create a sample query for you.

Best regards,
No Magic, Inc. Customer Support
ieva.n
No Magic
No Magic
 
Posts: 362
Posts Rating:28
Joined: Thu Aug 02, 2012 5:02 am
Full name: Ieva

Next

Return to SysML

Who is online

Users browsing this forum: No registered users and 0 guests