> For the complete documentation index, see [llms.txt](https://ai-native-development.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ai-native-development.gitbook.io/docs/general/comment-to-code.md).

# Comment to code

Generate code from comments with GitHub Copilot

[![](https://img.shields.io/badge/Lv3-Mature_Best_Practice-brightgreen)](https://github.com/orgs/AI-Native-Development/projects/1/)

## Description

GitHub Copilot is capable of generating new code based on the specific text provided by a developer. By defining conditions in the form of comments, GitHub Copilot can create code that responds to the requirements.

### Example

Here's a way to instruct GitHub Copilot to create a function through comments:

```javascript
// Function name: calculateAverage
// Function arguments: numbers (array)
// Return type of the function: number
```

Based on these comments, Copilot might suggest the following code:

```javascript
function calculateAverage(numbers: number[]): number {
    // calculate the average of the array
    const sum = numbers.reduce((a, b) => a + b);
    return sum / numbers.length;
}
```

## Exerecise

* **Exercise 1**: Write the comments to instruct Copilot to create a function that calculates the maximum number in an array. Use the following specification:

```javascript
// Function name: calculateMax
// Function arguments: numbers (array)
// Return type of the function: number
```

* **Exercise 2**: Test the generated function with different sets of numbers and verify if it returns the correct maximum value.

## Checklist for Further Learning

* Is the generated code based on the specified conditions?
* Is the functionality of the code correctly implemented?
* What is the appropriate way to write comments for more complex condition definitions?
* To give more context, try using the OS dictation functionality as well as the keyboard.