12. Documentación

Comentarios de calidad

README.md
(exp personal): mantenerse lejos del detalle

Awesome README | Curated list of awesome lists | Project-Awesome.orgproject-awesome.org

TODOs y FIXMEs

TODO: algo que dejas incompleto a sabiendas
FIXME: algo que puede causar una issue/bug
(exp. personal): Poner el ID de la herramienta de ticketing
(exp. personal): Dejar enlaces de la investigación que has hecho, en el futuro sabrás por donde tirar.

// TODO LAM-2950
// Fix deprecated warning (error for storybook >= v7)
// @see https://storybook.js.org/docs/react/writing-stories/decorators#global-decorators
addDecorator(literalsDecorator);

// FIXME LAM-3258
// <ScreenList /> depends on <ScreenCardController /> */
function ScreenList(props) {

Comentarios de mala calidad

/**
 * @param {itemId} itemId
 */
function getItemPrice(itemId) {}

/**
 * fetch item name
 */
function getItemPrice(itemId) {}

Ejercicio: cómo comentarias esta función?

function getFileInfoFromFolder(path) => {
  const files = fs.readdirSync(path, 'utf8');
  const response = [];
  for (let file of files) {
    const extension = path.extname(file);
    const fileSizeInBytes = fs.statSync(file).size;
    response.push({ name: file, extension, fileSizeInBytes });
  }
  return response;
}