Want to create interactive content? It’s easy in Genially!

Get started free

Documentació i Bones Pràctiques de Programació

Jorge Llorente

Created on September 19, 2025

Start designing with a free template

Discover more than 1500 professional designs like these:

Process Flow: Corporate Recruitment

Weekly Corporate Challenge

Wellbeing and Healthy Routines

Match the Verbs in Spanish: Present and Past

Planets Sorting Game

Syllabus Organizer for Higher Education

Internal Guidelines for Artificial Intelligence Use

Explore all templates

Transcript

Jordi Llorente Díaz

Documentació i Bones Pràctiques de Programació

Desplegament d' aplicacions web
Cicle Grau Superior Desenvolupament d'aplicacions web
Algú ha intentat reprendre un projecte antic i no s'enrecordava del que feia el codi?
...o teballar en equip i no entendre el que havia fet un company?

Solució: Documentar!

Documentació i Bones Pràctiques de Programació
Jordi Llorente Díaz

Per què és tan important documentar?

  • Mantenimient més senzill
  • Continuació amb més funcionalitats -> SaaS
  • Treball en equip més fluid
  • Reducció d'errors
  • Professionalització del projecte
Jordi Llorente Díaz
Documentació i Bones Pràctiques de Programació

Elements que formen part de la documentació

  • Comentar el codi -> És el més important
  • Wiki
  • README
  • Altres instruccions
Jordi Llorente Díaz
Documentació i Bones Pràctiques de Programació

Com es comenta el codi?

Un bon comentari no descriu què fa el codi, sinó per què es fa.

La descripció del que fa el codi ja es veu al mateix codi, bé perquè sabem el que fa la funció o bé perquè fem servir variables que es descriuen per si soles.

Jordi Llorente Díaz
Documentació i Bones Pràctiques de Programació
Jordi Llorente Díaz
Documentació i Bones Pràctiques de Programació

Quines eines tenim per comentar el codi?

  • Javadoc -> Java
  • JSDoc -> JavaScript
  • Les pròpies dels IDEs
Jordi Llorente Díaz
Documentació i Bones Pràctiques de Programació