---
title: "Comments"
canonical_url: "https://handbook.propay.co.za/php/comments"
---
# Comments

Comments SHOULD be avoided as much as possible by writing expressive code. If you do need to use a comment to explain the what, then [refactor](https://refactoring.guru/refactoring/techniques) the code. If you need to explain the reason (why), then format the comments as follows:

<code-group>

```php [PHP]
// There should be a space before a single line comment.

/*
 * If you need to explain a lot you can use a comment block. Notice the
 * single * on the first line. Comment blocks don’t need to be three
 * lines long or three characters shorter than the previous line.
 */
```

</code-group>


## Sitemap

See the full [sitemap](https://handbook.propay.co.za/sitemap.md) for all pages.
