From 0b7073152e5b463f03cbf29326701751ad5eb815 Mon Sep 17 00:00:00 2001 From: daixihegu Date: Thu, 25 Jun 2026 00:22:43 +0800 Subject: [PATCH] docs: add NatSpec to Script and Test base contracts Signed-off-by: daixihegu --- src/Script.sol | 6 ++++-- src/Test.sol | 6 ++++-- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/src/Script.sol b/src/Script.sol index d43fa8a7..03e0beba 100644 --- a/src/Script.sol +++ b/src/Script.sol @@ -21,8 +21,10 @@ import {VmSafe} from "./Vm.sol"; // 📦 BOILERPLATE import {ScriptBase} from "./Base.sol"; -// ⭐️ SCRIPT +/// @notice Default base contract for Forge scripts. +/// @dev Includes safe cheatcodes, chain helpers, utility helpers, and console modules. abstract contract Script is ScriptBase, StdChains, StdCheatsSafe, StdUtils { - // Note: IS_SCRIPT() must return true. + /// @notice Marker used by Forge to identify script contracts. + /// @dev The generated `IS_SCRIPT()` getter must return true. bool public IS_SCRIPT = true; } diff --git a/src/Test.sol b/src/Test.sol index af91dd81..204d5837 100644 --- a/src/Test.sol +++ b/src/Test.sol @@ -25,8 +25,10 @@ import {Vm} from "./Vm.sol"; // 📦 BOILERPLATE import {TestBase} from "./Base.sol"; -// ⭐️ TEST +/// @notice Default base contract for Forge tests. +/// @dev Includes assertions, cheatcodes, invariant helpers, chain helpers, utility helpers, and console modules. abstract contract Test is TestBase, StdAssertions, StdChains, StdCheats, StdInvariant, StdUtils { - // Note: IS_TEST() must return true. + /// @notice Marker used by Forge to identify test contracts. + /// @dev The generated `IS_TEST()` getter must return true. bool public IS_TEST = true; }