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.