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.