Clean Code (Comment)

Elliot Anderson — Mon, 20 May 2024 11:00:37 +0000

clean code like an art or play an instrument.

dirty code it's bring you to a conclusion in short time.
but when your software enters in the market and users use your software you confront with huge amount of bugs and in is that time your code (complexity + dependency) equal to bankruptcy of a business or a group or company.

your code must be tell your program story

generally comments the less the better.
when a person write comment for any class, function and etc
he knows better then anyone, he's code is dumb and over time, he realizes this amount of confusion and frequent turns in his code.

even write comment has rules you can't write any comment you like.

Some good comments

Legal Comments

Sometimes our corporate coding standards force us to write certain comments for legal
reasons. For example, copyright and authorship statements are necessary and reasonable
things to put into a comment at the start of each source file.

Clarification

Sometimes it is just helpful to translate the meaning of some obscure argument or return
value into something that’s readable. In general it is better to find a way to make that argu-
ment or return value clear in its own right; but when its part of the standard library, or in
code that you cannot alter, then a helpful clarifying comment can be useful.

TODO Comments

t is sometimes reasonable to leave “To do” notes in the form of //TODO comments. In the
following case, the TODO comment explains why the function has a degenerate implementa-
tion and what that function’s future should be.

Some bad comments

Mumbling

Plopping in a comment just because you feel you should or because the process requires it,
is a hack. If you decide to write a comment, then spend the time necessary to make sure it
is the best comment you can write.

Journal Comments

Sometimes people add a comment to the start of a module every time they edit it. These
comments accumulate as a kind of journal, or log, of every change that has ever been
made. I have seen some modules with dozens of pages of these run-on journal entries.

Position Markers

Sometimes programmers like to mark a particular position in a source file. For example, I
recently found this in a program I was looking through:

//---------------- API FETCH ------------------------

you can see any bad or good comments in linux project

https://github.com/torvalds/linux

Developing or building software is like music. A musician can play an untuned instrument well in front of people and no one can understand the quality of the music. But a professional musician can easily notice your bad performance.

Conclusion :

Generally if you work in the large team and you all have the same commenting rules and have some developers for updates your old comments can use commenting.

But you should consider that if you are in a small or medium team, committing to a project can have serious consequences.
You should consider that you have to do tasks such as bugs, updates, refactoring, adding new features, etc. and if all of these include commenting, you will completely destroy the productivity of the product system. you did and in the future that group will be doomed to failure.

Thanks for reading.

Regards Elliot :)

Why use javaScript typed arrays

Elliot Anderson — Sun, 19 May 2024 15:03:09 +0000

First of all what is the is typed array

JavaScript typed arrays are array-like objects that provide a mechanism for reading and writing raw binary data in memory buffers.

You can read more details from JS-TYPE-ARRAYS

So when i read about js typed array i cant find answer about

Why use it in our project and after searching a lot about it, I found an article and code about it.

Type insurance

Let’s suppose you want numeric, or specifically Uint8 values at some function for the purpose of analyzing or processing bytes. If a Uint8Array is passed to this function, then the function does not have to make safety checks and validations on the type and the code will be cleaner.

Nonverbal communication

Other developers will have an easy time understanding what values such an array will contain, while an array with unspecified element type may contain “anything”.

Memory optimization

Let’s suppose you are storing 1024 integer values in this array. If you use up a single byte per item, then you are using only 1 KB for the items of this array.

Example

Consider a clinic where there are 3 queues of patients, surface patients, critical patients and emergency patients, each of these queues are 10–20–30 long respectively, and there should not be more than these amounts of disruption in the queue and the clinic. How do you implement such a structure?

We need 3 type arrays with the following names

Superficial patients (Max Patients 10)
Critical patients (Max Patients 20)
Emergency patients (Max Patients 30)

‍const patientsBuffer = new ArrayBuffer(30);‍
const superficialPatients = new Uint8Array(patientsBuffer, 0, 10);
const criticalPatients = new Uint8Array(patientsBuffer, 0, 20);
const emergencyPatients = new Uint8Array(patientsBuffer, 0, 30);

console.log(emergencyPatients.byteLength); // 10
console.log(emergencyPatients.length); // 30
console.log(criticalPatients[0]); // 0, the initial value

As you have seen, we were able to create arrays by using ArrayBuffer & Uint8Array , which in the first step is the optimal use of memory storage.
second stage
The limit of the range of each queue
The third step is the readability and cleanliness of the code.

Use array-typed Optimize your program and Enjoy Coding

Thanks for reading this short article.
Elliot .

DEV Community: Elliot Anderson