Skip to content

comments can be written in NatSpec for better DX #60

@0xStrobe

Description

@0xStrobe

croc's contracts are fairly abstract, so devs often need to jump in and follow the source code to understand how many of the features work

although well documented, i think its better to format comments into the NatSpec standard, so the comments can be picked up by toolings automatically. for example, etherscan injects the comments into the "contract ui" for all documented public methods, vscode shows the entire comments on hover, and docs can be auto generated as well

not sure if etherscan allows reverifying contract source code

currently, the comments start with /*

image image

vs

image

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions