Comments

Test yourself

Comments

Comments are lines of code that are ignored completely by the computer.

What are comments?

A comment is a line of code that is completely ignored by the computer.
Comments can be used to add description to your code to make it easier for other people to understand.
They can also be used to leave notes and reminders to yourself as you work on a complex program.

How to comment

To write a comment in most languages, you must use a special character which tells the computer to ignore the rest of the line:
- In Python, that character is a #.

Interfaces

An interface is a collection of comments which describe a subroutine.
An interface includes:
- List of parameters and their types.
- Return value and its type.
- What the subroutine does.

Interface example

1Introduction to Python

1.1Python

1.1.1Python

1.2Input & Output

1.2.1Input & Output

1.3Data Types

1.3.1Data Types

1.4Variables & Constants

1.4.1Variables & Constants

1.5Operators

1.5.1Arithmetic & Relational Operators

1.5.2Boolean & Assignment Operators 2

1.6Program Flow

1.6.1Selection

1.6.2Iteration

2Data Structures

2.1Lists & Strings

2.1.1Lists

2.1.2Strings

2.2File Handling

2.2.1File Handling

3Modularity

3.1Subroutines

3.1.1Subroutines

3.2Data Flow

3.2.1Data Flow

4Good Practice

4.1Naming & Whitespace

4.1.1Identifiers

4.1.2Whitespace

4.2Comments

4.2.1Comments

4.3Exceptions

4.3.1Exceptions

Jump to other topics