写自动化测试脚本时,很多人只关注功能实现,忽略了代码和文档的排版。其实,清晰的结构和良好的格式能大大提升团队协作效率。比如你写的脚本同事接手时一看就懂,省去反复沟通的时间,就像厨房里调料分门别类摆好,做饭自然顺手。
用缩进和空行划分逻辑块
测试脚本虽然不是小说,但也需要“段落”。比如一个登录流程的测试,可以把打开页面、输入账号、点击登录、验证结果分成几个视觉区块。适当加空行,配合统一缩进,读起来不费劲。
def test_user_login():
driver = webdriver.Chrome()
driver.get("https://example.com/login")
username_input = driver.find_element_by_id("username")
password_input = driver.find_element_by_id("password")
username_input.send_keys("testuser")
password_input.send_keys("123456")
login_button = driver.find_element_by_id("login-btn")
login_button.click()
assert "dashboard" in driver.current_url
driver.quit()
注释不是越多越好,关键是“说人话”
别写“初始化驱动”,这种是废话。换成“启动浏览器,准备测试环境”就更清楚。注释要解释“为什么这么做”,而不是重复代码干了啥。比如某个等待时间设成5秒,可以备注“等待第三方接口响应,实测最长4.8秒”。
测试用例命名要有场景感
别用 test_01、test_func 这种名字。换成 test_login_with_invalid_password 或者 test_cart_total_updates_after_adding_item,别人一眼就知道这个脚本在验什么。就像快递单上写“张三收,北京市朝阳区”,比“某人收,某地”靠谱多了。
把常见操作封装成模块,目录也要整洁
如果你有10个脚本都要登录,那就把登录过程写成一个公共函数,放在 utils/login_helper.py 里。项目目录看起来清爽,修改时也只改一处。别让每个脚本都复制一遍登录代码,那就像每封邮件都从头写称呼和落款,累死人。
用 Markdown 写配套说明文档
脚本旁边放个 README.md,用简单标题列出:测试目的、运行方式、依赖环境、预期结果。不需要花哨排版,但信息要完整。新人第一天入职,照着文档就能跑通,不用到处问人。