1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
|
// Copyright 2015 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
// Package comment.
package pkg
import "io"
// Constants
// Comment about exported constant.
const ExportedConstant = 1
// Comment about internal constant.
const internalConstant = 2
// Comment about block of constants.
const (
// Comment before ConstOne.
ConstOne = 1
ConstTwo = 2 // Comment on line with ConstTwo.
constThree = 3 // Comment on line with constThree.
)
// Const block where first entry is unexported.
const (
constFour = iota
ConstFive
ConstSix
)
// Variables
// Comment about exported variable.
var ExportedVariable = 1
var ExportedVarOfUnExported unexportedType
// Comment about internal variable.
var internalVariable = 2
// Comment about block of variables.
var (
// Comment before VarOne.
VarOne = 1
VarTwo = 2 // Comment on line with VarTwo.
varThree = 3 // Comment on line with varThree.
)
// Var block where first entry is unexported.
var (
varFour = 4
VarFive = 5
varSix = 6
)
// Comment about exported function.
func ExportedFunc(a int) bool {
return true != false
}
// Comment about internal function.
func internalFunc(a int) bool
// Comment about exported type.
type ExportedType struct {
// Comment before exported field.
ExportedField int // Comment on line with exported field.
unexportedField int // Comment on line with unexported field.
ExportedEmbeddedType // Comment on line with exported embedded field.
*ExportedEmbeddedType // Comment on line with exported embedded *field.
*qualified.ExportedEmbeddedType // Comment on line with exported embedded *selector.field.
unexportedType // Comment on line with unexported embedded field.
*unexportedType // Comment on line with unexported embedded *field.
io.Reader // Comment on line with embedded Reader.
error // Comment on line with embedded error.
}
// Comment about exported method.
func (ExportedType) ExportedMethod(a int) bool {
return true != true
}
func (ExportedType) Uncommented(a int) bool {
return true != true
}
// Comment about unexported method.
func (ExportedType) unexportedMethod(a int) bool {
return true
}
type ExportedStructOneField struct {
OnlyField int // the only field
}
// Constants tied to ExportedType. (The type is a struct so this isn't valid Go,
// but it parses and that's all we need.)
const (
ExportedTypedConstant ExportedType = iota
)
// Comment about constructor for exported type.
func ExportedTypeConstructor() *ExportedType {
return nil
}
const unexportedTypedConstant ExportedType = 1 // In a separate section to test -u.
// Comment about exported interface.
type ExportedInterface interface {
// Comment before exported method.
//
// // Code block showing how to use ExportedMethod
// func DoSomething() error {
// ExportedMethod()
// return nil
// }
//
ExportedMethod() // Comment on line with exported method.
unexportedMethod() // Comment on line with unexported method.
io.Reader // Comment on line with embedded Reader.
error // Comment on line with embedded error.
}
// Comment about unexported type.
type unexportedType int
func (unexportedType) ExportedMethod() bool {
return true
}
func (unexportedType) unexportedMethod() bool {
return true
}
// Constants tied to unexportedType.
const (
ExportedTypedConstant_unexported unexportedType = iota
)
const unexportedTypedConstant unexportedType = 1 // In a separate section to test -u.
// For case matching.
const CaseMatch = 1
const Casematch = 2
func ReturnUnexported() unexportedType { return 0 }
func ReturnExported() ExportedType { return ExportedType{} }
const MultiLineConst = `
MultiLineString1
MultiLineString2
MultiLineString3
`
func MultiLineFunc(x interface {
MultiLineMethod1() int
MultiLineMethod2() int
MultiLineMethod3() int
}) (r struct {
MultiLineField1 int
MultiLineField2 int
MultiLineField3 int
}) {
return r
}
var MultiLineVar = map[struct {
MultiLineField1 string
MultiLineField2 uint64
}]struct {
MultiLineField3 error
MultiLineField2 error
}{
{"FieldVal1", 1}: {},
{"FieldVal2", 2}: {},
{"FieldVal3", 3}: {},
}
const (
_, _ uint64 = 2 * iota, 1 << iota
constLeft1, constRight1
ConstLeft2, constRight2
constLeft3, ConstRight3
ConstLeft4, ConstRight4
)
const (
ConstGroup1 unexportedType = iota
ConstGroup2
ConstGroup3
)
const ConstGroup4 ExportedType = ExportedType{}
func newLongLine(ss ...string)
var LongLine = newLongLine(
"someArgument1",
"someArgument2",
"someArgument3",
"someArgument4",
"someArgument5",
"someArgument6",
"someArgument7",
"someArgument8",
)
type T2 int
type T1 = T2
const (
Duplicate = iota
duplicate
)
// Comment about exported function with formatting.
//
// Example
//
// fmt.Println(FormattedDoc())
//
// Text after pre-formatted block.
func ExportedFormattedDoc(a int) bool {
return true
}
type ExportedFormattedType struct {
// Comment before exported field with formatting.
//
// Example
//
// a.ExportedField = 123
//
// Text after pre-formatted block.
ExportedField int
}
type SimpleConstraint interface {
~int | ~float64
}
type TildeConstraint interface {
~int
}
type StructConstraint interface {
struct { F int }
}
|
