Accéder à un commentaire dans une fonction dans Go

Question

Je travaille actuellement sur un générateur de documentation qui va analyser le code Go pour produire une documentation personnalisée. J'ai besoin d'accéder aux commentaires écrits à l'intérieur d'une fonction. Mais je ne peux pas récupérer ces commentaires dans l'AST, ni avec go/doc. Voici un exemple:

package main 

import (
    "fmt" 
    "go/doc" 
    "go/parser" 
    "go/token" 
) 

// GetFoo comments I can find easely 
func GetFoo() { 
    // Comment I would like to access 
    test := 1 
    fmt.Println(test) 
} 

func main() { 
    fset := token.NewFileSet() // positions are relative to fset 
    d, err := parser.ParseDir(fset, "./", nil, parser.ParseComments) 
    if err != nil { 
     fmt.Println(err) 
     return 
    } 
    for k, f := range d { 
     fmt.Println("package", k) 
     p := doc.New(f, "./", 2) 

     for _, t := range p.Types { 
      fmt.Println("type", t.Name) 
      fmt.Println("docs:", t.Doc) 
     } 

     for _, v := range p.Vars { 
      fmt.Println("type", v.Names) 
      fmt.Println("docs:", v.Doc) 
     } 

     for _, f := range p.Funcs { 
      fmt.Println("type", f.Name) 
      fmt.Println("docs:", f.Doc) 
     } 

     for _, n := range p.Notes { 
      fmt.Println("body", n[0].Body) 
     } 
    } 
} 

Il est facile de trouver GetFoo comments I can find easely mais pas Comment I would like to access Je l'ai vu ce post tout à fait de la même question Go parser not detecting Doc comments on struct type mais pour les types exportés

Est-il possible de le faire? Je vous remercie !

Answer 1

Le problème est que la fonctionnalité doc.New analyse uniquement les chaînes de documentation et que le commentaire à l'intérieur de la fonction ne fait pas partie de la "documentation".

Vous devez directement parcourir l'ensemble des fichiers du package.

package main 

import (
     "fmt" 
     "go/parser" 
     "go/token" 
) 

// GetFoo comments I can find easely 
func GetFoo() { 
     // Comment I would like to access 
     test := 1 
     fmt.Println(test) 
} 

func main() { 
     fset := token.NewFileSet() // positions are relative to fset 
     d, err := parser.ParseDir(fset, "./", nil, parser.ParseComments) 
     if err != nil { 
       fmt.Println(err) 
       return 
     } 
     for k, f := range d { 
       fmt.Println("package", k) 
       for n, f := range f.Files { 
         fmt.Printf("File name: %q\n", n) 
         for i, c := range f.Comments { 
           fmt.Printf("Comment Group %d\n", i) 
           for i2, c1 := range c.List { 
             fmt.Printf("Comment %d: Position: %d, Text: %q\n", i2, c1.Slash, c1.Text) 
           } 
         } 
       } 

     } 
}