duanliang1898 2015-05-07 05:11
浏览 131
已采纳

go / ast软件包中的Doc和Comment有什么区别?

I am using the go/ast and go/parser package to do something, but i am puzzled about the difference between Doc and Comment.

Is the first line of comments a Doc, then others as Comment?
Here is a sample:

TypeSpec struct {
    Doc     *CommentGroup // associated documentation; or nil
    Name    *Ident        // type name
    Type    Expr          // *Ident, *ParenExpr, *SelectorExpr, *StarExpr, or any of the *XxxTypes
    Comment *CommentGroup // line comments; or nil
}
  • 写回答

1条回答 默认 最新

  • dsfdsfdsfdsf1223 2015-05-07 05:20
    关注

    From src/go/ast/ast.go#L70-L75:

    // A CommentGroup represents a sequence of comments
    // with no other tokens and no empty lines between.
    

    Following Godoc: documenting Go code:

    • Doc is one or several continuous lines of comments (// ...) before the TypeSpec

    write a regular comment directly preceding its declaration, with no intervening blank line

    // A TypeSpec node represents a type declaration (TypeSpec production).
    ^^^^^^^^^^^^...
    TypeSpec struct {
    
    • Comment is a comment associate to the field itself, starting on the same line, but which can spread over multiple continuous lines (hence "CommentGroup")

      Name    *Ident        // type name
                            ^^^^^^^^^^^
                            // the comment associated to Name
                            // could go on over several lines
      
    本回答被题主选为最佳回答 , 对您是否有帮助呢?
    评论

报告相同问题?

悬赏问题

  • ¥15 孟德尔随机化怎样画共定位分析图
  • ¥18 模拟电路问题解答有偿
  • ¥15 Matlab在app上输入带有矩阵形式的初始条件发生错误
  • ¥15 CST仿真别人的模型结果仿真结果S参数完全不对
  • ¥15 误删注册表文件致win10无法开启
  • ¥15 请问在阿里云服务器中怎么利用数据库制作网站
  • ¥60 ESP32怎么烧录自启动程序
  • ¥50 html2canvas超出滚动条不显示
  • ¥15 java业务性能问题求解(sql,业务设计相关)
  • ¥15 52810 尾椎c三个a 写蓝牙地址