CODEWITHSUNDEEP
scalascaladoc
John
John

Reputation: 1591

How to read scala documentation using reflection

Is there anyway we can read scala doc comments using reflection. My requirement is to read the @group tag value and use it for counting how many functions are there for each group

Upvotes: 1

Views: 294

Answers (1)

Jörg W Mittag
Jörg W Mittag

Reputation: 369458

No, you can't use Scala reflection to access documentation comments. The reason is simple: comments are, almost by definition, not part of the program. Therefore, it is logically impossible for them to be available via reflection.

In Python, for example, documentation is available from the running program (in fact, even without using reflection), because the documentation is not hidden away in comments, but rather simply assigned to a field of the object that is being documented. Many Lisps (e.g. Clojure), and also Ioke and Seph work that way, too.

In Newspeak, what they call "comments" is available using reflection, but that's because what they call "comments" are not really comments, it is more like arbitrary metadata that can be attached to objects. It is in fact more similar to an annotation in Scala than a comment.

In Scala, documentation is written in comments, and comments are not part of the program (they are literally equivalent to whitespace in the Scala Language Specification), and therefore, cannot possibly be part of the program and thus cannot possibly be accessed via reflection.

Upvotes: 4

Related Questions