rice class : GetComment(string) method

Description

Returns a named comment.

Syntax

riceInstance.GetComment(string commentName)

Arguments

ClassNameDescription
stringcommentNameComment name.

Return value

ClassDescription
stringComment body.

Sample code

1:

/**Sample**concat**-----------------------

2:

This is a

3:

sample.

4:

-----------------------------------------------*/

5:

rice rr;

6:

string body = rr.GetComment("Sample"); // body is "This is a sample.".

Notes

If the comment name do not exist, this method throw the UnknownException(KeyNotFoundException).

Links for reference

Copyright © Rice All rights reserved.