crytic/slither

Parse natspec comments for functions, events, errors, state variables

Open

#1,916 建立於 2023年5月15日

在 GitHub 查看
 (0 留言) (0 反應) (0 負責人)Python (4,769 star) (886 fork)batch import
enhancementgood first issue

描述

Describe the desired feature

Want to build a detector to detect if natspec comments are missing.

貢獻者指南

技術棧
python
領域
securitydocumentation
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-2 days
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
fresh
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
mostly clear
前置要求
Solidity basicsFamiliarity with Slither's detector frameworkPython
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
60
研究方向
Research existing detectors in Slither to understand the detector structure. Look into how natspec comments are stored in the AST (e.g., in the Solidity compiler output or Slither's internal representation). Implement a new detector that checks for missing natspec on functions, events, errors, and state variables. No linked PRs or comments are available.