ホームページ >バックエンド開発 >PHPチュートリアル >javascript - 単一行のコメントは行末またはコードの上に配置する必要がありますか?
単一行コメントを追加する必要がある場合、開発者は通常、単一行コメントをコード行の最後に配置しますか、それともコードの上の独自の行に配置する必要がありますか?それとも特定の状況と詳細な分析ですか?それは個人的な習慣ですか、それともあなた自身の理由がありますか。もっと学ぶために、みんなで話し合っていただければと思います。
行末
上
を追加する必要がある場合、開発者は通常、単一行コメントをコード行の最後に配置しますか、それともコードの上の独自の行に配置する必要がありますか?それとも特定の状況と詳細な分析ですか?それは個人的な習慣なのでしょうか、それとも何か理由があるのでしょうか。もっと学ぶために、みんなで話し合っていただければと思います。
リーリー
リーリー
1. 変数の宣言または初期化を右側に配置します
2. 短いコード ブロックの宣言を上部に配置します
3. コメントが長すぎる場合は、複数行のコメントを使用して上部に配置します
重要な点は、コメントのためのコメントをしないことです。コードが明確に理解できる場合は、その方向に最善を尽くしてください。結局のところ、「コードの美しさ」はありますが、「コメントの美しさ」については聞いたことがありません。
詳細はリンクの説明を参照してください。
フォーマッタなどを使用する場合は、最後に 1 行のコメントを追加してください。そうしないと、一部の書式設定ツールによってフォーマットが少しおかしくなります。
上にコメントを書いてください。一般的にフォーマットされたコメントは API にエクスポートできます。
その後、読むためのメモがあるので、好きなことを書いてください。いずれにせよ、あなた以外の誰もあなたのコメントを読むことはありません。ドキュメントのコメントは通常、先頭にあります。適当に書いたコメントは無駄に感じる
コメント形式:
1. 単一行コメント: //……
/*&*/
3. /**&*/
4. Javadoc コメントタグの構文
//……
2、块(block)注释:/*……*/
3、文档注释:/**……*/
個人的なプロジェクトの経験から、次のように使用するのが適切です:
リーリー
2. 呼び出しメソッドには通常、ブロックの注釈が付けられ、上部に配置されます。 リーリーjsdoc について言及している人を見かけましたが、私は個人的に
の jsdoc 中国語版のドキュメントを参照します。
コメントについてですが、個人的には、行コメントは行位置に、ブロックコメントは行頭に書くべきだと思っています。
jsdoc
それは個人的な習慣です!
短くて似たものを、コードの後ろに置くだけです。
習慣的に空を入力することもあります:
。
個人の習慣によっては、後から置いた方が良いです//
個人的には、コメントに関しては 3 つの優先順位があるべきだと考えています: プロジェクトの要件仕様が最上位である、プロジェクトに要件がない場合は、公式の基準に従う、公式の基準がない場合は、独自の基準に従う。 。 あなた自身の基準については、上記の回答を引用します: 「コメントのためのコメントはしないでください。」 コメントの目的は、複雑なコードを明確にして理解しやすくすることです
。
個人の習慣やチームの習慣に注目してください。
1、简短代码块声明放在上方
2、注释过长就使用多行注释,并放在上方
所以说,个人习惯
我习惯写上面
写上面比较好 可以与上一行代码隔离开 能够清晰一些
可以试试jsDoc规则
http://usejsdoc.org/
jsdoc明确规定了,注释块注释放上面,单行注释放右侧。
除了公司规定就照这个经念就可以
这个具体看公司代码规范了,如果没有代码规范明确限制,自己写注释最好放在上面,不然你一会儿代码上面一个注释,一会代码右边一个注释,自己看的时候就觉得乱了
个人习惯放在上面。
ps:注释用来说明代码的功能块或者不太容易理解的模块。不要随便写注释
至于单行注释写在上面好还是写在下面好,都没关系,我一般注释都是这样:
<code>// XXX功能 start ... do { xxxxx... } while(x...); ... // XXX功能 end</code>
说实在虽然放后面比较好看注释,但用起来有时候很纠结,特别是如果想在数组元素后面加注释的时候,在加了注释之后,发现要加一个新元素的时候,需要再去添加,
。
栗子:
<code>$test = [ a, //a b //b,如果需要在后面添加一个元素,需要补上,号,虽然可以在最后元素加上,不报错,但是对于强迫症来讲,不喜欢多余的,号 ]</code>
如果是一个功能的话会在上面,单独注释一行代码的话会在尾部更随。
注释只是为了增加代码的可阅读性 并且 一般来说 短行代码 在右侧注释比较友好 而长行代码 在头部或下行注释 便于看清不乱
个人习惯 都在上面 ,单行注释右边的话,可能会造成需要拖动滚动条才能看到后面的
尽量写在上方,方便查看
看注释长度。。。
不同语言注释规范也不一样,python就用#或者"""""",最好跟规范走
习惯......