【Xilinx】如何自动格式化Verilog代码

开发环境Vivado+VSCode

前言

有时候接手别人的代码,或者从网上找的开源代码,每个人风格不一致,对齐缩进也不一样,阅读起来很累。
有没有什么方法能快捷地格式化代码呢。下面我们利用VSCode插件来实现这个需求。

一、安装VSCode并修改Vivado的默认编辑器

VSCode安装就不赘述了,网上有很多教程

VSCode安装完成后,打开Vivado,点击settings
在这里插入图片描述
在这里插入图片描述

找到VSCode的安装路径,输入文件路径+code.exe+[file name] -[line number]
比如在我电脑上是
D:\Users\leo\AppData\Local\Programs\Microsoft VS Code\Code.exe
则输入

D:\Users\leo\AppData\Local\Programs\Microsoft VS Code\Code.exe [file name]-[line number]

这样每次双击.v文件,都会自动打开VSCode。
这个稍微有点麻烦的是VSCode不是集成在Vivado里面,点开会是新窗口。所以最好是双屏开发,一个显示器显示Vivado,一个显示器显示VSCode。可能对用笔记本单屏开发的不是很友好。

二、安装Verilog插件

1. 语法插件

这个插件主要是用于语法高亮显示。

它也可以做格式化,但是不如后面介绍的那个好用,配置起来有点麻烦,有些资源需要vpn,不太通用。有兴趣的可以自己研究
在这里插入图片描述

2. 格式化插件

在这里插入图片描述

三、演示:如何代码格式化

1. 插件演示

首先故意在174行插入一些空格,让它与其他行不对齐
在这里插入图片描述

然后右键选择Format Document
在这里插入图片描述
第一次使用会弹出一个配置对话框,选Configure
在这里插入图片描述

因为我装了好几个格式化插件,这里选第一个。
你也可以选其他的插件,相关的格式化插件有很多,看自己习惯而定。
在这里插入图片描述

点击后可以看到174行重新与其他行对齐了

在这里插入图片描述

2. 修改默认插件

如果后续想修改默认插件,右键选择Format Document With

在这里插入图片描述

如果只是临时测试其他插件,选上面提示的即可。
如果要永久修改,则选最后一行 Configure Default Formatter,然后重新选择需要的插件
在这里插入图片描述

附录

一些比较好的链接

实现自动纠错和TestBench
https://blog.csdn.net/qq_39498701/article/details/84668833

解决vscode无法产生testbench的问题
https://blog.csdn.net/hackerwpf/article/details/114658490

用VSCode编辑verilog代码、iverilog编译、自动例化、自动补全、自动格式化等常用插件
https://zhuanlan.zhihu.com/p/338497672

软件介绍: VerilogHDL代码格式器一键完成格式VerilogHDL代码    本软件暂时只支持VerilogHDL代码文件(*.v),替代传统的使用空格或者tab字符手动调整代码格式的方法. 添加代码文件(*v)后,只需点击格式化代码按钮,软件就会开始对列表中选定的代码文件进行格式化,并在代码列表中显示代码格式化的结果.代码文件状态智能检测    提供文件状态智能检测功能.代码文件刚加入文件列表中,状态显示为问号.经过格式化处理成功后状态显示为对钩.如果文件在外部被修改,本软件也会自动检测到,并将文件状态显示为问号.支持批量的代码文件格式化    可以格式化单个代码文件,也可以添加多个代码文件,认定批量任务.同时可以把当前文件列表导出为列表文件(*.flst),也可以通过列表文件导入文件列表.可自定义多种灵活的代码格式    软件提供GNU,ANSI,KR三种常见的代码格式风格,也为用户提供了用户自定义的代码格式.用户自定义的格式可以导出为格式配置文件(*.ini),也可以导入该配置文件,快速设置代码格式.代码格式效果即时预览    用户在修改代码格式设置时,可以在左侧的预览窗口看到即时效果.不断地调整设置,直到用户满意为止.用户在设置格式时,可以选择启用或者禁用用户自定义的设置.启用自定义设置是在当前选定的标准代码风格的基础上进行的.格式化自动保存    经过格式化成功的代码,软件自动保存到原来的位置.在进行格式化操作时,软件会自动代码文件进行备份.备份文件的文件扩展名可以用户自己选择为*.v_bak,或*.org,或*.old.没有格式化成功的代码将不被修改.高亮显示语法和注释        语法检测并蓝色高亮显示的方法,可以根据需要显示常用的关键字. 代码注释分为行注释(//)和块注释(/**/),都显示为绿色.语法和注释高亮显示,可以大大方便代码的阅读.使用时需要注意的问题    (1)软件不支持带中文的文件路径;    (2)在开始代码格式化的时候,请务必在QuartusII或ISE等官方集成开发环境(IDE)中先将代码保存,然后再启动代码格式化.否则软件格式化代码将不包含在这些IDE中的修改;    (3)在使用本软件格式化代码完毕后,切换回QuartusII或ISE等集成开发环境(IDE)时,会提示,选择是进行重新加载,则此时加载进来的代码就是本软件格式化过后的代码;    (4)在进行代码格式化之前,建议先成功编译.因为针对不合语法的Verilog代码,格式化之后可以会出现格式破坏的可能.
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值