Clean code: principle and best practice

zonaetmunna — Sun, 15 Oct 2023 04:42:24 +0000

Clean code is a concept that refers to writing code in such a way that it is easy to understand, easy to maintain, and easy to modify. The principles and best practices for writing clean code can be summarized as follows:

1. Meaningful Names:

Use descriptive, unambiguous names for variables, functions, classes, and modules.
Avoid disinformation (e.g., using a variable name l that looks like 1 or I).
Make meaningful distinctions (e.g., getUserInfo vs getUserData).
Use pronounceable names.

2. Functions:

Functions should be small and do only one thing.
They should have a small number of parameters, ideally no more than three.
Function names should describe what they do.
Functions should not have side effects that are not obvious from the name.

3. Comments:

Comments should explain why something is done, not what is done.
Avoid redundant comments that just repeat the code.
Update comments when code changes.
Use comments to mark incomplete code or areas that need improvement.

4. Formatting:

Code should be consistently indented and formatted.
Use blank lines to separate sections of code that are logically related.
Follow the coding standards of your team or organization.

5. Error Handling:

Use exceptions rather than return codes for error handling.
Don't ignore exceptions.
Provide context with exceptions to make them more helpful.

6. Unit Tests:

Write tests for your code.
Tests should be clean, too – easy to read, easy to understand, and easy to modify.
Tests should cover various cases and edge conditions.

7. DRY (Don't Repeat Yourself):

Avoid duplication of code.
Use abstraction, functions, or classes to avoid code duplication.

8. Simplicity:

Write simple code that gets the job done.
Avoid over-engineering and premature optimization.
Remove unnecessary code.

9. Code Review:

Regularly review your code with colleagues to catch mistakes and get suggestions for improvement.

10. Refactoring:

Continuously refactor your code to make it cleaner.
Make one change at a time and test it before moving on.

11. Code Cohesion:

Keep related code together.
Ensure that classes and modules have a clear responsibility.

12. Use Design Patterns Wisely:
Use design patterns where they are needed, but don't force them into your code.

15. Code Documentation:
Write documentation that explains how to use your code, especially for libraries and APIs.

javaScript useful method

zonaetmunna — Wed, 22 Dec 2021 07:19:21 +0000

Javascript string and array function

toLowerCase: toLowerCase() method is convert any string to lower case.
toUpperCase: toUpperCase() method is convert any sting to upper case
Searching method:
indexOf:
includes:
startWith:
endWith:
Array methods
split:
slice:
subStr:
subString:
concat:
join:

Array searching method
isArray:
indexOf:
includes:
concat:

CSS position property

zonaetmunna — Sun, 19 Dec 2021 17:29:28 +0000

I just simply write CSS position tropic. I explore some web tutorials and find out some main concepts. I want to just share people for my study and grow my skills and I want to spread and share with people my knowledge.
CSS position:
CSS position property positioning any element in a web page. how an element stays on a web page depends on the CSS position property. position property has some value static, absolute, relative, fixed, sticky.
Static:
Static is the default value of the position property. Top,bottom,left,right,z-index are not affect.
Have 3 div element.their default value is static.
Relative:
Relative value

DEV Community: zonaetmunna

Clean code: principle and best practice

javaScript useful method

Javascript string and array function

CSS position property