v.ast: document vlib/v/ast/ast.v (#7624)

vlib/v/ast/ast.v

@@ -158,25 +158,27 @@ pub mut:
 	typ  table.Type
 }
 
+// const field in const declaration group
 pub struct ConstField {
 pub:
 	mod      string
 	name     string
-	expr     Expr
+	expr     Expr // the value expr of field; everything after `=`
 	is_pub   bool
 	pos      token.Position
 pub mut:
-	typ      table.Type
+	typ      table.Type // the type of the const field, it can be any type in V
-	comments []Comment
+	comments []Comment // comments before current const field
 }
 
+// const declaration
 pub struct ConstDecl {
 pub:
 	is_pub       bool
 	pos          token.Position
 pub mut:
-	fields       []ConstField
+	fields       []ConstField // all the const fields in the `const (...)` block
-	end_comments []Comment
+	end_comments []Comment // comments that after last const field
 }
 
 pub struct StructDecl {
@@ -258,26 +260,29 @@ pub mut:
 // import statement
 pub struct Import {
 pub:
+	mod   string // the module name of the import
+	alias string // the `x` in `import xxx as x`
 	pos   token.Position
-	mod   string
-	alias string
 pub mut:
-	syms  []ImportSymbol
+	syms  []ImportSymbol // the list of symbols in `import {symbol1, symbol2}`
 }
 
+// import symbol,for import {symbol} syntax
 pub struct ImportSymbol {
 pub:
 	pos  token.Position
 	name string
 }
 
+// anonymous function
 pub struct AnonFn {
 pub:
 	decl FnDecl
 pub mut:
-	typ  table.Type
+	typ  table.Type // the type of anonymous fn. Both .typ and .decl.name are auto generated
 }
 
+// function or method declaration
 pub struct FnDecl {
 pub:
 	name            string
@@ -319,6 +324,7 @@ pub:
 	pos   token.Position
 }
 
+// function or method call expr
 pub struct CallExpr {
 pub:
 	pos                token.Position
@@ -349,6 +355,7 @@ pub struct AutofreeArgVar {
 	idx  int
 }
 */
+// function call argument: `f(callarg)`
 pub struct CallArg {
 pub:
 	is_mut          bool
@@ -362,6 +369,7 @@ pub mut:
 	// tmp_name        string // for autofree
 }
 
+// function return statement
 pub struct Return {
 pub:
 	pos      token.Position
@@ -434,18 +442,21 @@ pub mut:
 	end_comments []Comment
 }
 
+// Each V source file is represented by one ast.File structure.
+// When the V compiler runs, the parser will fill an []ast.File.
+// That array is then passed to V's checker.
 pub struct File {
 pub:
-	path             string
+	path             string // path of the source file
-	mod              Module
+	mod              Module // the module of the source file (from `module xyz` at the top)
 	global_scope     &Scope
 pub mut:
 	scope            &Scope
-	stmts            []Stmt
+	stmts            []Stmt // all the statements in the source file
-	imports          []Import
+	imports          []Import // all the imports
-	imported_symbols map[string]string // 'Type' => 'module.Type'
+	imported_symbols map[string]string // used for `import {symbol}`, it maps symbol => module.symbol
-	errors           []errors.Error
+	errors           []errors.Error // all the checker errors in the file
-	warnings         []errors.Warning
+	warnings         []errors.Warning // all the checker warings in the file
 	generic_fns      []&FnDecl
 }
 
@@ -723,10 +734,11 @@ pub:
 	name string
 }
 */
+// variable assign statement
 pub struct AssignStmt {
 pub:
 	right         []Expr
-	op            token.Kind
+	op            token.Kind // include: =,:=,+=,-=,*=,/= and so on; for a list of all the assign operators, see vlib/token/token.v
 	pos           token.Position
 	comments      []Comment
 	end_comments  []Comment
@@ -748,6 +760,7 @@ pub mut:
 	expr_type table.Type
 }
 
+// an enum value, like OS.macos or .macos
 pub struct EnumVal {
 pub:
 	enum_name string
@@ -758,25 +771,27 @@ pub mut:
 	typ       table.Type
 }
 
+// enum field in enum declaration
 pub struct EnumField {
 pub:
 	name          string
 	pos           token.Position
-	comments      []Comment
+	comments      []Comment // comment after Enumfield in the same line
-	next_comments []Comment
+	next_comments []Comment // comments between current EnumField and next EnumField
-	expr          Expr
+	expr          Expr // the value of current EnumField; 123 in `ename = 123`
-	has_expr      bool
+	has_expr      bool // true, when .expr has a value
 }
 
+// enum declaration
 pub struct EnumDecl {
 pub:
 	name             string
 	is_pub           bool
-	is_flag          bool // true when the enum has [flag] tag
+	is_flag          bool // true when the enum has [flag] tag,for bit field enum
-	is_multi_allowed bool
+	is_multi_allowed bool // true when the enum has [_allow_multiple_values] tag
-	comments         []Comment // enum Abc { /* comments */ ... }
+	comments         []Comment // comments before the first EnumField
-	fields           []EnumField
+	fields           []EnumField // all the enum fields
-	attrs            []table.Attr
+	attrs            []table.Attr // attributes of enum declaration
 	pos              token.Position
 }