addComment

Class: slreq.Requirement
Package: slreq

Add comments to requirements

Syntax

newComment = addComment(req,myComment)


Description

newComment = addComment(req,myComment) adds a comment, myComment, to the requirement req.

Input Arguments

req — Requirement

slreq.Requirement object

Requirement, specified as an slreq.Requirement object.

myComment — Comment text

string scalar | character vector

Comment text to add to the requirement, specified as a string scalar or character vector.

Output Arguments

newComment — New comment data

struct

New comment data, returned as a structure containing these fields:

CommentedBy — Name of individual or organization who added comment

character vector

Name of the individual or organization who added the comment, returned as a character vector.

CommentedOn — Date that comment was added

datetime

Date that the comment was added, returned as a datetime object.

CommentedRevision — Comment revision number

int32 object

Comment revision number, returned as an int32 object.

Text — Comment text

character vector

Comment text, returned as a character vector.

Examples

Add Comments to Requirements

This example shows how to add comments to requirements.

Load the requirement set basicReqSet.

rs = slreq.load("basicReqSet");

Find the first requirement in the set.

req = find(rs,Index=1);

Add a comment to the requirement.

newComment = addComment(req,"My new comment.");

Tips

• To add comments to referenced requirements, use slreq.Reference.addComment. To add comments to justifications, use slreq.Justification.addComment. To add comments to links, use slreq.Link.addComment.

Alternative Functionality

App

You can also add a comment by using the Requirements Editor. Select a requirement and, in the right pane, under Comments, click Add Comment.

Version History

Introduced in R2017b