Thank you for your contribution. It is really hard to understand your post, please try to make it little understandable as because not everyone knows about the work you are doing, so it's always better to explain little deep. Commenting on the code is always good because it benefits the developers who are reading your code, to understand more about the project.
Your contribution has been evaluated according to Utopian policies and guidelines, as well as a predefined set of questions pertaining to the category.
To view those questions and the relevant answers related to your post, click here.
Need help? Write a ticket on https://support.utopian.io/.
Chat with us on Discord.
[utopian-moderator]
I've written a lengthy readme visible on the github project page which details what the project is for, how it works, a tutorial with many screenshots, and the "quick guide" image at the top of this post, which I hoped would quickly give the concept. I've also updated the readme with the updates given here. If you have a specific question, please ask here or on the Discord (pengo)
The initial version had every single functional line commented as well as having a lengthy readme with many screenshots and still received a Utopian comment score of "Very low - the added comments provide no value or are not present at all." I have had feedback from users who have no problem using the tool, so I'm at a loss for how to provide adequate documentation for the utopian project.
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.
Fair enough. I'll definitely break that up and/or comment it more when I next have a chance to work on it.