RE: Updates to sendemtiny.exe

You are viewing a single comment's thread from:

Updates to sendemtiny.exe

in utopian-io •  7 years ago 

I have seen you have commented on your code but what I mean is that some of the complex logic is still missing the documentation or comment. Let's say for example, you have written a regex, which is quite big,

var regex = new Regex(@"[Uu][+-]?(?<hex>[0-9A-Fa-f]{2,})|say\W(?<say>.*)|type\W(?<type>.*)|(?<entity>&(?:[a-z\d]+|#\d+|#x[a-f\d]+);)|(?<time>(?<num>\d+(?:\.\d+)?)\W*(?<unit>s|ms))");

Now if I am a newbie in the project I will not understand what exactly this Regex does, so explaining it would be highly appreciated. Thus we say that commenting and explaining the complex logic is necessary for open source project because that helps the people who will be using your code.

Authors get paid when people like you upvote their post.
If you enjoyed what you read here, create your account today and start earning FREE STEEM!
Sort Order:  

Fair enough. I'll definitely break that up and/or comment it more when I next have a chance to work on it.