Write Clean Code Comments #1 | Clean Code Tutorial

Key Takeaways

okay visual markers so why are visual markers oftentimes a bad practice well usually what they're doing is they're either providing information that is very apparent and there's no need to provide that information or it's trying to make sense of something that probably should be in a different file right and so oftentimes you'll see i'm in one of two ways you'll see them with the the dots let's have something like this where like you know by convention for instance your dependencies usually go at the top of the file and you know most of our linters and things like that will take care of that so there's really no reason to even have a comment like that and then you have super unnecessary ones where take a example of our class here where you just go properties right properties almost always go first and our linters will even ensure that and it's very apparent that that's not really necessary now in a case where you have multiple files like this you might even see user class admin class things like this to show a distinction between the two this is a good example of where instead of actually having a common getting rid of it go and create a new file right go and do your admin.class.js or something like that and instead take this gut it out in one file put in another file of course get rid of the the comment and get rid of this one as well because really at the end of the day you know there's a little bit of disagreement on this depending on who you ask but in my opinion you want to have a single file per class and that'll make your life a little bit easier and also eliminate some of these visual cues that really at the end of the day are good indicators of a anti-pattern to showcase that hey maybe our file here has multiple purposes and that is an issue in itself so when you see those visual cues think about it see how you might be able to break it up to make it so they don't need it and make your life a little bit easier one last thing i wanted to add on here i didn't really need a entire screencast for it is don't leave to do's in in your code you know you might have even before put to do move into two files right something like that at the end of the day priorities change you things change and just be like nike and do it no more to do so keep that in mind