search

GoogleCloudPlatform / samples-style-guide

Guidelines on writing effective Google Cloud samples.
https://googlecloudplatform.github.io/samples-style-guide/
Apache License 2.0
11 stars 19 forks source link

Terraform style guidance showcases multiple comment styles #110

Open grayside opened 1 year ago

grayside commented 1 year ago

Description

Many languages support multiple commenting styles, but as a matter of style guide preference choose a single commenting style. Let's make the style guide consistent on comments in terraform example code. We might also consider having a commenting syntax guideline.

Using # per line: https://googlecloudplatform.github.io/samples-style-guide/#result Using /* .. */ style: https://googlecloudplatform.github.io/samples-style-guide/#description Using /* .. */ with * per line: https://googlecloudplatform.github.io/samples-style-guide/#minimal-arguments

Impact

Code style consistency, low work impact.