Comments | Godot GDScript Tutorial | Ep 04

Summary

The video script explains the importance and types of comments in programming, specifically in GD Script. It describes two methods for writing comments: single-line using the pound sign and multi-line using triple double quotes. Four common types of comments are discussed: methodology, metadata, debugging, and code description. The script emphasizes using meaningful variable names and refactoring before resorting to comments for clarity. It advises against using comments for version control and suggests using platforms like GitHub or Bitbucket instead.

Takeaways

• 📝 Comments are programmer-readable annotations in the source code that help explain the code but are ignored by the compiler.
• 🔑 There are two primary ways to write comments in GDScript: using the pound sign (#) for single-line comments and using three double quotation marks for multi-line comments.
• 💬 Multi-line comments in GDScript are treated as multi-line strings, not actual comments, by the compiler.
• 🔍 Four common types of comments are methodology description, metadata, debugging, and code description comments.
• 🔑 Methodology description comments explain the reasoning behind the choice of algorithms or methods in the code.
• 📜 Metadata comments often appear at the top of scripts and include information like the project name, file name, creation year, maintainers, and copyright.
• 🐛 Debugging comments are used to temporarily disable code, such as print statements, during the debugging process.
• 🛠 Code description comments clarify the purpose of a line of code, but should be used sparingly and after considering meaningful variable names.
• 🔄 It's better to use clear variable names and refactoring to make code self-explanatory before resorting to comments for intent.
• 🤔 Comments should explain the 'why' behind the code, not just the 'how', and should be used when code readability reaches its limit.
• ❌ Avoid using comments as a form of version control or to track changes made by individuals, as tools like GitHub or Bitbucket are more appropriate for this purpose.

Q & A

What are comments in programming?

Comments are programmer-readable annotations in the source code of a program. They are used to explain the code, making it easier for others to understand the intent and methodology behind the code.

How many ways are there to write a comment in GDScript?

There are two ways to write a comment in GDScript: using the pound sign (#) for single-line comments and using three double quotation marks for multi-line comments.

What is considered when using the pound sign symbol in GDScript?

The pound sign symbol is used for single-line comments in GDScript. Anything written after the pound sign is considered a comment and is not part of the actual code that the compiler will read.

Why is a multi-line comment in GDScript treated as a multi-line string?

A multi-line comment in GDScript is treated as a multi-line string because the compiler reads it as such. It is not a real comment but a string that can be included in the code.

What are the four common types of comments mentioned in the script?

The four common types of comments mentioned are methodology description comments, metadata comments, debugging comments, and code description comments.

What is the purpose of methodology description comments?

Methodology description comments are used to explain the reasoning behind the choice of algorithms or methods in the code, rather than just the intent of the code itself.

Where are metadata comments typically found and what do they include?

Metadata comments are typically found at the top of a script and may include information such as the company name, file name, year of creation, names of maintainers, copyright, and more.

What is the purpose of debugging comments and how are they usually implemented?

Debugging comments are used during the process of finding and fixing errors in the code. They often involve commenting out print statements to temporarily disable them, with the intention of using them again later.

What is the difference between code description comments and meaningful variable names?

Code description comments are used to explain the intent of a line of code, whereas meaningful variable names are chosen to inherently convey the purpose of the variable, reducing the need for additional comments.

Why should comments not be used as a source of version control?

Comments should not be used as a source of version control because they are not designed to track changes made by individuals over time. Instead, version control systems like GitHub or Bitbucket should be used for this purpose.

What is the general rule of thumb for using comments in code?

The general rule of thumb is that code tells you 'how' something is done, while comments explain 'why' it is done that way. Comments should be used to provide rationale and intent when code alone is not self-explanatory.