#
followed by a specific keyword. There are several different kinds of annotations at your disposal:/* */ or //), instead of a docstring comment (/** **/ or ///
) it will be ignored!#
) your annotation will also be ignored! Scribble will issue a warning in most cases when this happens.@custom:
natspec tag. As of Scribble v0.6.1 we also support annotations prefixed with @custom:scribble
. Note that the pound sign before keywords is still requried! (i.e. you need to write @custom:scribble #if_succeeds ...
instead of @custom:scribble if_succeeds ...
)..yaml
files and applied to a contract with the /// #macro name(var1, var2, ...).
annotation.#require
annotations#try
annotations