Bitsmi Blog
Asciidoc - Reference
3.- Functions
Small
- Functions max up to 20 lines.
- Always small.
- They are the main line of organization in any program.
4.- Comments
Comments are not good by nature. They can be understood as a failure because we haven’t been good enough when writing the source code.
Comments are also dangerous because they are lying due to the fact that programmers do not maintain them.
They are also very dangerous when the comments are inaccurate.
Truth can only be found in one place: the code. Only the code can truly tell you what it does. It is the only source of truly accurate information.
Note: Comments can be useful in some exceptional cases.
2.- Meaningful names
Simple rules for creating good names
Choosing good names takes time but saves more time than it takes.
The name of a variable, function or class should answer all the big questions: why it exists, what it does and how it is used.
As an example, if we want to be evoked of a date name by the specification of how it is being measured and the unit of that measurement we can use names like these:
int elapsedTimeInDays
int daysSinceCreation
We have to be sure that we acquire the implicity of the code: the degree to which the context is not explicit in the code itself.
About the implicity of the code of a variable as an example, we need to know the answers to questions as:
-
What kinds of things are in variable x?
-
What is the significance of the value x?
-
How would I use the x variable being returned?
1.- Clean Code
Anyone reading this book:
- Is a programmer.
- Is a programmer who wants to be a better programmer.
After reading this book:
- We will be able to tell the differences between good code and bad code.
- We will know how to write good code.
- We will know how to transform bad code into good keeping its business requirements.
0.- Introduction
Summary
These group of posts pretend to be a quick summary to check when required to gather and review the most important concepts of the book.
It is recommended to read the book to get more detailed information about the topic that the reader wants to review.
Introduction
For coding is not enough to gain knowledge of principles, patterns, practices and heuristics.
It requires a continuing try and failure because Clean Code is a hard work process to learn from it.
The book has been split in three main parts:
-
The first part describes the principles, patterns and practices of writing clean code.
-
Study cases with different complexity. It will be an intense and demanding part. Main reason why is that each case analysed is an exercise in cleaning some code that has problems and transforming it into a code with less problems than the original version.
-
Heuristics and Smells. It is related to the relationship between the heuristics and the discrete decisions made while doing some clean up of the source code.
As a general rule, it is recommended by the author to read the WHOLE book and practice as much as possible to gain a much richer understanding of these principles, patterns and heuristics.
Tabla de Códigos ASCII – American Standard Code for Information Interchange
Estándar Americano de Codificación para el Intercambio de Información
Pronunciación: as-ki
ASCII es un estándar de representar caracteres y símbolos en forma electrónica. Emplea estándares incrementando la eficiencia y elimina errores. Utilizar estándares requiere disciplina y a veces restringe la creatividad.
Sin embargo, es muy útil para la comunicación entre usuarios. Internet requiere aún más enfoque en estándares porque en muchos casos, se trata de usuarios de idiomas diferentes.
Las personas que tuvieron la visión de Internet, establecieron una plataforma de comunicación global. El uso de los estándares es una manera de cumplir con este objetivo.
IntelliJ Hotkeys Cheatsheet
Tabla de códigos HTML
Tabla de ASCII estándar, nombres de entidades HTML, ISO 10646, ISO 8879, ISO 8859-1 romano 1 con soporte para todos los navegadores.