Tag

documentation

#documentation

More content

Read more stories on Hashnode

Articles with this tag

Code Smell 151 - Commented Code

Jul 22, 20222 min read105 views

Beginners are afraid to remove code. And many seniors too. · TL;DR: Don't leave commented code. Remove it. Problems Readability Dead Code Lack of...

Code Smell 151 - Commented Code

Code Smell 148 - ToDos

Jul 12, 20222 min read121 views

We buy debt for our future selves. It is payback time · TL;DR: Don't leave TODOs in your code. Fix them! Problems Technical Debt Readability Lack of...

Code Smell 148 - ToDos

Code Smell 75 - Comments Inside a Method

Jun 5, 20212 min read623 views

Comments are often a code smell. Inserting them inside a method calls for an urgent refactor. · TL;DR: Don't add comments inside your methods. Extract...

Code Smell 75 - Comments Inside a Method

Code Smell 74 - Empty Lines

Jun 4, 20211 min read584 views

Breaking the code to favor readability asks for refactor. TL;DR Don't add empty lines to your methods. Extract...

Code Smell 74 - Empty Lines

Code Smell 05 - Comment Abusers

Oct 24, 20202 min read1.3K views

The code has lots of comments. Comments are coupled to implementation and hardly maintained. · TL;DR: Leave comments just for important design...

Code Smell 05 - Comment Abusers