Com escriure un comentari en un llenguatge de programació per ordinador: 4 passos

Taula de continguts:

Com escriure un comentari en un llenguatge de programació per ordinador: 4 passos
Com escriure un comentari en un llenguatge de programació per ordinador: 4 passos

Vídeo: Com escriure un comentari en un llenguatge de programació per ordinador: 4 passos

Vídeo: Com escriure un comentari en un llenguatge de programació per ordinador: 4 passos
Vídeo: CREAR BASE DE DATOS EN OPENOFFICE 2024, Març
Anonim

Quan es programa en un ordinador, de vegades és necessari deixar notes o comentaris perquè altres desenvolupadors puguin navegar fàcilment pel vostre codi. Tant si es tracta d’un projecte de codi obert com d’un projecte propietari, calen comentaris per coordinar-se amb els co-desenvolupadors i possibles futurs desenvolupadors. Sense comentaris, el codi simplement no es podria mantenir.

Passos

Escriviu un comentari en un llenguatge de programació per ordinador Pas 1
Escriviu un comentari en un llenguatge de programació per ordinador Pas 1

Pas 1. Comprendre el propòsit de comentar un programa d'ordinador

  • La llegibilitat és la clau aquí. Quan mireu un comentari, heu de saber que és un comentari i no una línia de codi.
  • El comentari també hauria de ser útil no només per a vosaltres, sinó per a qualsevol altra persona que pugui llegir el codi font del programa d’ordinador.
Escriviu un comentari en un llenguatge de programació per ordinador Pas 2
Escriviu un comentari en un llenguatge de programació per ordinador Pas 2

Pas 2. Penseu en una manera breu i senzilla de transmetre el vostre punt

Els comentaris no cal que siguin una obra d’art. Han de ser concisos, ordenats i directes al punt.

Tanmateix, això no hauria de desincentivar l'ús de diverses línies per fer un comentari. La qüestió és que la informació ha d’arribar al lector

Escriviu un comentari en un llenguatge de programació per ordinador Pas 3
Escriviu un comentari en un llenguatge de programació per ordinador Pas 3

Pas 3. Escriviu el comentari utilitzant la sintaxi adequada donada pel llenguatge de programació

Escriviu un comentari en un llenguatge de programació per ordinador Pas 4
Escriviu un comentari en un llenguatge de programació per ordinador Pas 4

Pas 4. Pregunteu-vos si el comentari que heu escrit és prou detallat

Un comentari hauria de ser capaç de dir a algú que mira el codi font què fa realment aquella part del programa sense haver de compilar-lo i executar-lo. El vostre comentari ho aconsegueix? Transmet tots els detalls?

Recomanat: