编程与AWS新手求教:如何在VS Code中注释Terraform代码?
如何在VS Code中注释Terraform代码
Terraform的注释规则和多数脚本语言类似,在VS Code里操作也很便捷,以下是具体方法:
单行注释
- Terraform的单行注释以
#开头,注释内容会被Terraform忽略 - 示例:
# 这是一条单行注释,用来解释下面的S3桶资源 resource "aws_s3_bucket" "my_bucket" { bucket = "my-example-bucket" # 行内注释,说明桶名称 }
- VS Code快捷键:选中单行(或多行)代码后,按
Ctrl+/(Windows/Linux)或Cmd+/(Mac),可快速添加/取消单行注释
多行注释
- 多行注释用
/*开头,*/结尾,适合注释大段内容 - 示例:
/* 这是一段多行注释 用来说明整个资源块的业务用途: 下面的S3桶将用于存储静态网站的HTML、CSS和JS文件 后续会配置桶的静态网站托管功能 */ resource "aws_s3_bucket" "my_bucket" { bucket = "my-example-bucket" }
- VS Code快捷键:选中需要注释的多行内容后,按
Shift+Alt+A(Windows/Linux)或Shift+Option+A(Mac),可快速添加/取消多行注释
新手注意事项
- 多行注释不要嵌套使用,否则会导致语法错误或注释失效
- 注释尽量聚焦代码无法直接体现的逻辑(比如业务意图),不要重复代码本身的内容
内容的提问来源于stack exchange,提问作者ngum ebune
相关产品推荐
相关产品推荐

