Last year I wrote about having heredoc like strings available in JavaScript. Today I figured i’d briefly bring the topic back, providing a solution for returning an array of all comments found in a function:
Why is this useful? As you may know, writing multiline strings in JavaScript isn’t always the prettiest especially when you have to use \n
or \r\n
. On the other hand, let’s imagine that we have some multiline strings stored inside of a function as comments:
As you can see in the above jPaq Proof, by using the getComments
function on a function which contains comments you can pull the comments out as if they were HEREDOC strings. Have fun! 😎
NOTE: It is important to remember that if you are minifying your code, these comments will most-likely be stripped out. In this case you will want to find a different solution such as using the string escape characters (\r\n
or \n
).