GoogleCloudPlatform / GoogleCloudPlatform/samples-style-guide

Terraform style guidance showcases multiple comment styles

Open
#110 0 comments 0 reactions 0 assignees View on GitHub
guideline: needs work type: feature request
Dominant language
HTML
Stars
13
Forks
17
PR merge metrics
No merged PRs in 30d

Description

### 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.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.