Class ShScriptCommentStream


  • public class ShScriptCommentStream
    extends CommentStream
    This class extracts all ASCII characters within standard shell script comments. A shell comment begins with a "#" and ends at the end of a line. A single comment is regarded as a continuous set of lines that begin with "#". All leading "#: characters and any preceding blanks or tabs are ignored.
    See Also:
    CommentStream
    • Constructor Detail

      • ShScriptCommentStream

        public ShScriptCommentStream()
    • Method Detail

      • readComment

        public java.lang.String readComment()
                                     throws java.io.IOException
        Description copied from class: CommentStream
        Read the next comment from the input reader.
        Specified by:
        readComment in class CommentStream
        Returns:
        The next comment that is read from the stream.
        Throws:
        java.io.IOException - if there is a problem while reading the next comment.