Nocomment removes comments. Comments can either be line comments or block comments.
Comments will be elided from the text if the beginning comment delimiter is found and is not within quoted text: quoted text starts with a " and ends with a ".
Support for single-quotes, ', and/or raw quotes ` may be added.
For line comments, by default, nocomment interprets # and // as the beginning of a line comment. Line comments are terminated when an EOL is encountered: \r, \n, or \r\n.
There are toggles for whether or not an octothorpe (hash), #, or a double slash, // should be accepted as the beginning of a line comment. By default, both types of line comments are enabled. Disabling both types of line comments will result in line comments being preserved.
Configuration of line comments can only be done when using the Stripper struct.
Nocomment uses C style block comments, /* */. Block comments may span new lines.
Input is expected to be []byte and the cleaned input is returned as []byte.
import github.com/mohae/nocomment
To elide comments from text using nocomment's defaults:
cleaned := Clean(input)
If you want to configure what is accepted as line-comments, the Stripper struct must be used. This struct has exported methods which accept bool and allow for the toggling of line comment types: Stripper.SetIgnoreHash() and Stripper.SetIgnoreSlash().
Example
In this example, only // are allowed as line comments:
s := NewStripper()
s.SetIgnoreHash(true) // do not accept # as the start of a line comment.
Once set, the input is cleaned with the Clean() method, which accepts and returns []byte
cleaned := s.Clean(input)
https://godoc.org/github.com/mohae/nocomment
This is based on Rob Pike's lexer design. There is code in the package that has been copied from the source code within http://golang.org/src/text/template/parse/. The files containing any copied code also have the original copyright notices.
For license and copyright information on this package, please read the LICENSE file.