groovy-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Remi Forax <fo...@univ-mlv.fr>
Subject Re: About a new annotation Groovydoc
Date Fri, 24 Feb 2017 09:09:05 GMT
Technically,
Python was not the first language to introduce the idea of using a plain string at the start
of a function as documentation, all LISPs do that :)

Rémi

----- Mail original -----
> De: "Daniel Sun" <realbluesun@hotmail.com>
> À: dev@groovy.incubator.apache.org
> Envoyé: Vendredi 24 Février 2017 03:46:53
> Objet: About a new annotation Groovydoc

> Hi all,
> 
>      I am going to add a new annotation Groovydoc(Retention: RUNTIME),
> which is configurable(e.g. -Dgroovy.attach.annotation.groovydoc=true) and
> can be attached to target element at compilation time automatically.
> 
>      Groovydoc can be got easily even if Groovy source code is compiled
> into class files, it is a bit like Python's Documentation Strings and will
> be useful for IDE and developers who set a high value on documentations.
> BTW, currently groovydoc is attached as metadata of AST node, which is only
> avaliable at compilation time and is a bit hard to get(we have to use
> CompilationUnit, which is not familiar and friendly to most of Groovy
> developers)
> 
> # demo for Python's Documentation Strings
> def my_function():
>    """Do nothing, but document it.
>         No, really, it doesn't do anything.
>    """
>    pass
> print(my_function.__doc__)  # print the Documentation Strings of the
> function
> 
> 
>      Any thoughts?
> 
> Cheers,
> Daniel.Sun
> 
> 
> 
> --
> View this message in context:
> http://groovy.329449.n5.nabble.com/About-a-new-annotation-Groovydoc-tp5738721.html
> Sent from the Groovy Dev mailing list archive at Nabble.com.

Mime
View raw message