Can GitHub Copilot generate code documentation?

Kan GitHub Copilot code documentatie genereren?

Ja, GitHub Copilot Chat in Visual Studio Code kan codeblokken, -bestanden en complete projecten documenteren.

Hoe genereer je code documentatie met GitHub Copilot?

Documentatie voor codeblokken

1. Plaats de cursor in het codeblok dat je wilt documenteren.
2. Typ “/doc” in de chatbalk en druk op Enter.

Documentatie voor codebestanden

1. Plaats de cursor in het codebestand dat je wilt documenteren.
2. Typ “/doc file” in de chatbalk en druk op Enter.

Documentatie voor complete projecten

1. Plaats de cursor in de hoofdmap van het project dat je wilt documenteren.
2. Typ “/doc project” in de chatbalk en druk op Enter.

Extra opties

Je kunt GitHub Copilot ook gebruiken om:

• Opmerkingen te genereren voor specifieke functies, klassen of modules.
• Voorbeelden of tests toe te voegen aan je documentatie.
• Code te refactoren en te verbeteren.

Voorbeeld

Hier is een voorbeeld van hoe je code documentatie kunt genereren met GitHub Copilot:

// Functie om het gemiddelde van een array te berekenen
function getAverage(nums) {
  // Controleer of de array leeg is
  if (!nums.length) {
    return 0;
  }

  // Tel alle getallen in de array op
  let sum = 0;
  for (let num of nums) {
    sum += num;
  }

  // Bereken het gemiddelde
  return sum / nums.length;
}

Om documentatie te genereren voor de bovenstaande functie, kun je typen:

/doc

in de chatbalk. GitHub Copilot zal dan de volgende documentatie genereren:

/**
 * Bereken het gemiddelde van een array.
 *
 * @param {number[]} nums De array met getallen.
 * @returns {number} Het gemiddelde van de array.
 */
function getAverage(nums) {
  // Controleer of de array leeg is
  if (!nums.length) {
    return 0;
  }

  // Tel alle getallen in de array op
  let sum = 0;
  for (let num of nums) {
    sum += num;
  }

  // Bereken het gemiddelde
  return sum / nums.length;
}