Golang:带注释的代码行的惯例是什么?

Golang:带注释的代码行的惯例是什么?,第1张

概述代码格式约定的Go模型是“gofmt是约定”.该惯例的一部分我很难理解,并且很好地定义哪个gofmt是一个实现,而不是必须从经验实例中推导出该模型.这是一个样本. 去fmt之前: func sieve(mine int, // This instance's own prime inch chan int, // In 代码格式约定的Go模型是“gofmt是约定”.该惯例的一部分我很难理解,并且很好地定义哪个gofmt是一个实现,而不是必须从经验实例中推导出该模型.这是一个样本.

去fmt之前:

func sIEve(mine int,// This instance's own prime           inch chan int,// input channel from lower primes           done chan int,// Channel for signalling shutdown           count int) {               // Number of primes - counter    start := true                     // First-number switch    ouch := make(chan int)            // Output channel,this instance    fmt.Printf("%v ",mine)           // Print this instance's prime

去fmt之后:

func sIEve(mine int,// This instance's own prime    inch chan int,// input channel from lower primes    done chan int,// Channel for signalling shutdown    count int) { // Number of primes - counter    start := true                                 // First-number switch    ouch := make(chan int)                        // Output channel,mine)                       // Print this instance's prime

谁能帮我理解这里发生了什么?也就是说,为什么有些评论被不利地压缩,而其他评论则扩大了?一些理论:

>这太丑了,它必须意味着在同一行上没有注释的代码是首选
> gofmt中存在一个错误
>不完整(在某种程度上)行与完整行不同
>还有别的吗?

@R_502_6120@ 通常,参数在函数/方法文档中描述.考虑 math/big.(*Int).Exp docs:

// Exp sets z = x**y mod |m| (i.e. the sign of m is ignored),and returns z.// If y <= 0,the result is 1 mod |m|; if m == nil or m == 0,z = x**y.// See knuth,volume 2,section 4.6.3.func (z *Int) Exp(x,y,m *Int) *Int {

主要评论解释了x,y和m是什么以及它们之间的关系. This是godoc的外观呈现方式.

对于代码来说,每行通常都有自己的注释行:

// First-number switch.start := true// Output channel,this instance.ouch := make(chan int)// Print this instance's prime.fmt.Printf("%v ",mine)
总结

以上是内存溢出为你收集整理的Golang:带注释的代码行的惯例是什么?全部内容,希望文章能够帮你解决Golang:带注释的代码行的惯例是什么?所遇到的程序开发问题。

如果觉得内存溢出网站内容还不错,欢迎将内存溢出网站推荐给程序员好友。

欢迎分享,转载请注明来源:内存溢出

原文地址: http://outofmemory.cn/langs/1267010.html

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
上一篇 2022-06-08
下一篇 2022-06-08

发表评论

登录后才能评论

评论列表(0条)

保存