foundry-rs/forge-std

docs: enhance documentation with NatSpec for all public functions

Open

#653 创建于 2025年2月4日

在 GitHub 查看
 (1 评论) (1 反应) (0 负责人)Solidity (1,041 star) (499 fork)user submission
documentationhelp wanted

描述

Related: https://github.com/foundry-rs/book/issues/1303

To do:

Goals:

  • Document all public facing functions with @notice
  • Mark private variables and functions with underscore prefix https://github.com/foundry-rs/forge-std/pull/861
  • Unify layouts to follow common best practices of grouping storage variables
  • Move internal functions up, private functions down
  • Should not modify any user facing function or interface

This will make it easier to autogenerate documentation that we can then load into https://book.getfoundry.sh/reference/forge-std/ and keep it up to date

贡献者指南

技术栈
无
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
half day
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
fresh
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Basic Solidity knowledgeFamiliarity with NatSpec commentsUnderstanding of forge std project structure
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
85
研究方向
The issue requires adding NatSpec documentation (specifically @notice tags) to all public functions in the remaining files listed in the checklist: Base.sol, console.sol, console2.sol, safeconsole.sol, Script.sol, StdError.sol, StdMath.sol, StdUtils.sol, Test.sol, Vm.sol. Follow the conventions already established in completed files like StdAssertions.sol and the linked PRs (e.g., #860, #861). Ensure private variables and functions are prefixed with underscore. Do not modify any user facing function or interface. The goal is to enable autogenerated documentation for the Foundry book.