You are viewing a single comment's thread from:

RE: [KnackSteem API] - More security and features

This is high quality code and I'm pleased to see that!
Congrats on this project idea by the way.

A few remarks:

  • Your comments are great but it's a bit of an overkill. It feels like you want the best score from utopian :p => https://github.com/knacksteem/knacksteem-api/pull/11/files#diff-2dbc47226b708066000a2b1df9653f12R113 this one for instance, we know how to read code and your comment basically repeat what the code says but in english. You have a lot of them like that and honestly they are useless. For me, the comment should provide additional information. Like your comments at each function declaration, a short description, params explaination. This is great. Comment inside the code should only exists if the code is complicated to read. Otherwise it only pollutes I think.

  • https://github.com/knacksteem/knacksteem-api/pull/11/files#diff-fdcd0f9e663edcc4cebbc84cf0c97d50R148 => May be you could use the rule that's being disabled. Here I can see that's because ternary expression are nested and honestly you should favor code clarity other being concise. Here it takes a lot of time to understand what was written.
    You got a few lines disabled like that

And I think that's all :D. It's really small things because you've done an awesome work. Congrats! Keep coding that way.

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]

Sort:  

ahaahahah not really want to score best but I do agree with you hahahaahaha. I will follow your advise and not include comments everywhere :) just when needed. And now that I see, I did really write PARSE JSON METADATA 😂it is clear that is parsing it :P.

Thanks for your feedback. I will be more carefully when including comments inside the code.

Coin Marketplace

STEEM 0.21
TRX 0.25
JST 0.038
BTC 95634.12
ETH 3333.35
USDT 1.00
SBD 3.08