From the course: GitHub Copilot for Software Developers by Microsoft Press

Unlock this course with a free trial

Join today to access over 24,900 courses taught by industry experts.

Improve documentation consistency and readability

Improve documentation consistency and readability - Github Copilot Tutorial

From the course: GitHub Copilot for Software Developers by Microsoft Press

Start my 1-month free trial Buy for my team

Improve documentation consistency and readability

“

- All right, in this video, what we're going to do is we're going to take a look at how GitHub Copilot can help you, not just write a lot of your documentation in the first place, but also improve the clarity and consistency of your documentation whether that's full README files, or whether it's just something like inline code comments. All of those things can really contribute to the usability of your comments and therefore, the readability of your code by other developers, but also by yourself, you know, three months down the road. All right, so one of the most helpful use cases for Copilot in documentation is usually rewriting unclear comments or descriptions or updating them as the code changes, right? So I'm sure you've had this experience before, pretty much every developer has, where, you know, you're going through some code that you haven't seen in a while or haven't worked with ever before, and there's a comment that describes what a given line or a given function does, but…

Contents