Skip to content

Commit 7a565b8

Browse files
zhufuyizhufuyi
committed
docs: modify function comments
1 parent 6b48d50 commit 7a565b8

File tree

1 file changed

+28
-28
lines changed

1 file changed

+28
-28
lines changed

‎pkg/sql2code/parser/commonTemplate.go‎

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -49,31 +49,31 @@ import "validate/validate.proto";
4949
option go_package = "github.com/go-dev-frame/sponge/api/serverNameExample/v1;v1";
5050
5151
service {{.TName}} {
52-
// create a new {{.TName}}
52+
// Create a new {{.TName}}
5353
rpc Create(Create{{.TableName}}Request) returns (Create{{.TableName}}Reply) {}
5454
55-
// delete a {{.TName}} by {{.CrudInfo.ColumnNameCamelFCL}}
55+
// Delete a {{.TName}} by {{.CrudInfo.ColumnNameCamelFCL}}
5656
rpc DeleteBy{{.CrudInfo.ColumnNameCamel}}(Delete{{.TableName}}By{{.CrudInfo.ColumnNameCamel}}Request) returns (Delete{{.TableName}}By{{.CrudInfo.ColumnNameCamel}}Reply) {}
5757
58-
// update a {{.TName}} by {{.CrudInfo.ColumnNameCamelFCL}}
58+
// Update a {{.TName}} by {{.CrudInfo.ColumnNameCamelFCL}}
5959
rpc UpdateBy{{.CrudInfo.ColumnNameCamel}}(Update{{.TableName}}By{{.CrudInfo.ColumnNameCamel}}Request) returns (Update{{.TableName}}By{{.CrudInfo.ColumnNameCamel}}Reply) {}
6060
61-
// get {{.TName}} details by {{.CrudInfo.ColumnNameCamelFCL}}
61+
// Get a {{.TName}} by {{.CrudInfo.ColumnNameCamelFCL}}
6262
rpc GetBy{{.CrudInfo.ColumnNameCamel}}(Get{{.TableName}}By{{.CrudInfo.ColumnNameCamel}}Request) returns (Get{{.TableName}}By{{.CrudInfo.ColumnNameCamel}}Reply) {}
6363
64-
// get a list of {{.TName}} by custom conditions
64+
// Get a paginated list of {{.TName}} by custom conditions
6565
rpc List(List{{.TableName}}Request) returns (List{{.TableName}}Reply) {}
6666
67-
// delete {{.TName}} by batch {{.CrudInfo.ColumnNameCamelFCL}}
67+
// Batch delete {{.TName}} by {{.CrudInfo.ColumnNameCamelFCL}}
6868
rpc DeleteBy{{.CrudInfo.ColumnNamePluralCamel}}(Delete{{.TableName}}By{{.CrudInfo.ColumnNamePluralCamel}}Request) returns (Delete{{.TableName}}By{{.CrudInfo.ColumnNamePluralCamel}}Reply) {}
6969
70-
// get {{.TName}} details by custom condition
70+
// Get a {{.TName}} by custom condition
7171
rpc GetByCondition(Get{{.TableName}}ByConditionRequest) returns (Get{{.TableName}}ByConditionReply) {}
7272
73-
// get a list of {{.TName}} by batch {{.CrudInfo.ColumnNameCamelFCL}}
73+
// Batch get {{.TName}} by {{.CrudInfo.ColumnNameCamelFCL}}
7474
rpc ListBy{{.CrudInfo.ColumnNamePluralCamel}}(List{{.TableName}}By{{.CrudInfo.ColumnNamePluralCamel}}Request) returns (List{{.TableName}}By{{.CrudInfo.ColumnNamePluralCamel}}Reply) {}
7575
76-
// get a list of {{.TName}} by last {{.CrudInfo.ColumnNameCamelFCL}}
76+
// Get a paginated list of {{.TName}} by last {{.CrudInfo.ColumnNameCamelFCL}}
7777
rpc ListByLast{{.CrudInfo.ColumnNameCamel}}(List{{.TableName}}ByLast{{.CrudInfo.ColumnNameCamel}}Request) returns (List{{.TableName}}ByLast{{.CrudInfo.ColumnNameCamel}}Reply) {}
7878
}
7979
@@ -172,19 +172,19 @@ import "validate/validate.proto";
172172
option go_package = "github.com/go-dev-frame/sponge/api/serverNameExample/v1;v1";
173173
174174
service {{.TName}} {
175-
// create a new {{.TName}}
175+
// Create a new {{.TName}}
176176
rpc Create(Create{{.TableName}}Request) returns (Create{{.TableName}}Reply) {}
177177
178-
// delete a {{.TName}} by {{.CrudInfo.ColumnNameCamelFCL}}
178+
// Delete a {{.TName}} by {{.CrudInfo.ColumnNameCamelFCL}}
179179
rpc DeleteBy{{.CrudInfo.ColumnNameCamel}}(Delete{{.TableName}}By{{.CrudInfo.ColumnNameCamel}}Request) returns (Delete{{.TableName}}By{{.CrudInfo.ColumnNameCamel}}Reply) {}
180180
181-
// update a {{.TName}} by {{.CrudInfo.ColumnNameCamelFCL}}
181+
// Update a {{.TName}} by {{.CrudInfo.ColumnNameCamelFCL}}
182182
rpc UpdateBy{{.CrudInfo.ColumnNameCamel}}(Update{{.TableName}}By{{.CrudInfo.ColumnNameCamel}}Request) returns (Update{{.TableName}}By{{.CrudInfo.ColumnNameCamel}}Reply) {}
183183
184-
// get {{.TName}} details by {{.CrudInfo.ColumnNameCamelFCL}}
184+
// Get a {{.TName}} by {{.CrudInfo.ColumnNameCamelFCL}}
185185
rpc GetBy{{.CrudInfo.ColumnNameCamel}}(Get{{.TableName}}By{{.CrudInfo.ColumnNameCamel}}Request) returns (Get{{.TableName}}By{{.CrudInfo.ColumnNameCamel}}Reply) {}
186186
187-
// get a list of {{.TName}} by custom conditions
187+
// Get a paginated list of {{.TName}} by custom conditions
188188
rpc List(List{{.TableName}}Request) returns (List{{.TableName}}Reply) {}
189189
}
190190
@@ -290,69 +290,69 @@ option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
290290
};
291291
292292
service {{.TName}} {
293-
// create a new {{.TName}}
293+
// Create a new {{.TName}}
294294
rpc Create(Create{{.TableName}}Request) returns (Create{{.TableName}}Reply) {
295295
option (google.api.http) = {
296296
post: "/api/v1/{{.TName}}"
297297
body: "*"
298298
};
299299
}
300300
301-
// delete a {{.TName}} by {{.CrudInfo.ColumnNameCamelFCL}}
301+
// Delete a {{.TName}} by {{.CrudInfo.ColumnNameCamelFCL}}
302302
rpc DeleteBy{{.CrudInfo.ColumnNameCamel}}(Delete{{.TableName}}By{{.CrudInfo.ColumnNameCamel}}Request) returns (Delete{{.TableName}}By{{.CrudInfo.ColumnNameCamel}}Reply) {
303303
option (google.api.http) = {
304304
delete: "/api/v1/{{.TName}}/left_curly_bracket{{.CrudInfo.ColumnNameCamelFCL}}right_curly_bracket"
305305
};
306306
}
307307
308-
// update a {{.TName}} by {{.CrudInfo.ColumnNameCamelFCL}}
308+
// Update a {{.TName}} by {{.CrudInfo.ColumnNameCamelFCL}}
309309
rpc UpdateBy{{.CrudInfo.ColumnNameCamel}}(Update{{.TableName}}By{{.CrudInfo.ColumnNameCamel}}Request) returns (Update{{.TableName}}By{{.CrudInfo.ColumnNameCamel}}Reply) {
310310
option (google.api.http) = {
311311
put: "/api/v1/{{.TName}}/left_curly_bracket{{.CrudInfo.ColumnNameCamelFCL}}right_curly_bracket"
312312
body: "*"
313313
};
314314
}
315315
316-
// get {{.TName}} details by {{.CrudInfo.ColumnNameCamelFCL}}
316+
// Get a {{.TName}} by {{.CrudInfo.ColumnNameCamelFCL}}
317317
rpc GetBy{{.CrudInfo.ColumnNameCamel}}(Get{{.TableName}}By{{.CrudInfo.ColumnNameCamel}}Request) returns (Get{{.TableName}}By{{.CrudInfo.ColumnNameCamel}}Reply) {
318318
option (google.api.http) = {
319319
get: "/api/v1/{{.TName}}/left_curly_bracket{{.CrudInfo.ColumnNameCamelFCL}}right_curly_bracket"
320320
};
321321
}
322322
323-
// get a list of {{.TName}} by custom conditions
323+
// Get a paginated list of {{.TName}} by custom conditions
324324
rpc List(List{{.TableName}}Request) returns (List{{.TableName}}Reply) {
325325
option (google.api.http) = {
326326
post: "/api/v1/{{.TName}}/list"
327327
body: "*"
328328
};
329329
}
330330
331-
// delete {{.TName}} by batch {{.CrudInfo.ColumnNameCamelFCL}}
331+
// Batch delete {{.TName}} by {{.CrudInfo.ColumnNameCamelFCL}}
332332
rpc DeleteBy{{.CrudInfo.ColumnNamePluralCamel}}(Delete{{.TableName}}By{{.CrudInfo.ColumnNamePluralCamel}}Request) returns (Delete{{.TableName}}By{{.CrudInfo.ColumnNamePluralCamel}}Reply) {
333333
option (google.api.http) = {
334334
post: "/api/v1/{{.TName}}/delete/ids"
335335
body: "*"
336336
};
337337
}
338338
339-
// get a {{.TName}} by custom conditions
339+
// Get a {{.TName}} by custom conditions
340340
rpc GetByCondition(Get{{.TableName}}ByConditionRequest) returns (Get{{.TableName}}ByConditionReply) {
341341
option (google.api.http) = {
342342
post: "/api/v1/{{.TName}}/condition"
343343
body: "*"
344344
};
345345
}
346346
347-
// get a list of {{.TName}} by batch {{.CrudInfo.ColumnNameCamelFCL}}
347+
// Batch get {{.TName}} by {{.CrudInfo.ColumnNameCamelFCL}}
348348
rpc ListBy{{.CrudInfo.ColumnNamePluralCamel}}(List{{.TableName}}By{{.CrudInfo.ColumnNamePluralCamel}}Request) returns (List{{.TableName}}By{{.CrudInfo.ColumnNamePluralCamel}}Reply) {
349349
option (google.api.http) = {
350350
post: "/api/v1/{{.TName}}/list/ids"
351351
body: "*"
352352
};
353353
}
354354
355-
// get a list of {{.TName}} by last {{.CrudInfo.ColumnNameCamelFCL}}
355+
// Get a paginated list of {{.TName}} by last {{.CrudInfo.ColumnNameCamelFCL}}
356356
rpc ListByLast{{.CrudInfo.ColumnNameCamel}}(List{{.TableName}}ByLast{{.CrudInfo.ColumnNameCamel}}Request) returns (List{{.TableName}}ByLast{{.CrudInfo.ColumnNameCamel}}Reply) {
357357
option (google.api.http) = {
358358
get: "/api/v1/{{.TName}}/list"
@@ -512,37 +512,37 @@ option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
512512
};
513513
514514
service {{.TName}} {
515-
// create a new {{.TName}}
515+
// Create a new {{.TName}}
516516
rpc Create(Create{{.TableName}}Request) returns (Create{{.TableName}}Reply) {
517517
option (google.api.http) = {
518518
post: "/api/v1/{{.TName}}"
519519
body: "*"
520520
};
521521
}
522522
523-
// delete a {{.TName}} by {{.CrudInfo.ColumnNameCamelFCL}}
523+
// Delete a {{.TName}} by {{.CrudInfo.ColumnNameCamelFCL}}
524524
rpc DeleteBy{{.CrudInfo.ColumnNameCamel}}(Delete{{.TableName}}By{{.CrudInfo.ColumnNameCamel}}Request) returns (Delete{{.TableName}}By{{.CrudInfo.ColumnNameCamel}}Reply) {
525525
option (google.api.http) = {
526526
delete: "/api/v1/{{.TName}}/left_curly_bracket{{.CrudInfo.ColumnNameCamelFCL}}right_curly_bracket"
527527
};
528528
}
529529
530-
// update a {{.TName}} by {{.CrudInfo.ColumnNameCamelFCL}}
530+
// Update a {{.TName}} by {{.CrudInfo.ColumnNameCamelFCL}}
531531
rpc UpdateBy{{.CrudInfo.ColumnNameCamel}}(Update{{.TableName}}By{{.CrudInfo.ColumnNameCamel}}Request) returns (Update{{.TableName}}By{{.CrudInfo.ColumnNameCamel}}Reply) {
532532
option (google.api.http) = {
533533
put: "/api/v1/{{.TName}}/left_curly_bracket{{.CrudInfo.ColumnNameCamelFCL}}right_curly_bracket"
534534
body: "*"
535535
};
536536
}
537537
538-
// get {{.TName}} details by {{.CrudInfo.ColumnNameCamelFCL}}
538+
// Get a {{.TName}} by {{.CrudInfo.ColumnNameCamelFCL}}
539539
rpc GetBy{{.CrudInfo.ColumnNameCamel}}(Get{{.TableName}}By{{.CrudInfo.ColumnNameCamel}}Request) returns (Get{{.TableName}}By{{.CrudInfo.ColumnNameCamel}}Reply) {
540540
option (google.api.http) = {
541541
get: "/api/v1/{{.TName}}/left_curly_bracket{{.CrudInfo.ColumnNameCamelFCL}}right_curly_bracket"
542542
};
543543
}
544544
545-
// get a list of {{.TName}} by custom conditions
545+
// Get a paginated list of {{.TName}} by custom conditions
546546
rpc List(List{{.TableName}}Request) returns (List{{.TableName}}Reply) {
547547
option (google.api.http) = {
548548
post: "/api/v1/{{.TName}}/list"

0 commit comments

Comments
 (0)