javascript - Sollten einzeilige Kommentare am Ende der Zeile oder über dem Code platziert werden?

Wenn es notwendig ist, einen einzeiligen Kommentar hinzuzufügen, platzieren Entwickler den einzeiligen Kommentar im Allgemeinen am Ende der Codezeile oder platzieren ihn allein Zeile über dem Code? Oder handelt es sich um eine konkrete Situation und detaillierte Analyse? Ist es eine persönliche Angewohnheit oder hat es Ihre Gründe? Ich hoffe, dass jeder darüber diskutieren kann, damit ich mehr erfahren kann.

• Ende der Zeile

<code>var var1 = 5; // 声明并初始化变量，值为5</code>

• Oben

<code>// 声明并初始化变量，值为5
var var1 = 5; </code>

Antwortinhalt:

Wenn es notwendig ist, einen einzeiligen Kommentar hinzuzufügen, platzieren Entwickler den einzeiligen Kommentar im Allgemeinen am Ende der Codezeile oder platzieren ihn allein Zeile über dem Code? Oder handelt es sich um eine konkrete Situation und detaillierte Analyse? Ist es eine persönliche Angewohnheit oder hat es Ihre Gründe? Ich hoffe, dass jeder darüber diskutieren kann, damit ich mehr erfahren kann.

• Ende der Zeile

<code>var var1 = 5; // 声明并初始化变量，值为5</code>

• Oben

<code>// 声明并初始化变量，值为5
var var1 = 5; </code>

Im Allgemeinen sind meine persönlichen Gewohnheiten:
1. Platzieren Sie die Variablendeklaration oder Initialisierung rechts
2. Platzieren Sie kurze Codeblockdeklarationen oben
3. Verwenden Sie mehrzeilige Kommentare, wenn die Kommentare vorhanden sind zu lang, und platzieren Sie es über

Der entscheidende Punkt ist, nicht um des Kommentierens willen zu kommentieren. Die Benennung von Variablen, Funktionen usw. sollte standardisiert sein. Wenn der Code klar verständlich ist, versuchen Sie, in diese Richtung zu arbeiten. Schließlich gibt es die „Schönheit des Codes“, aber von der „Schönheit der Kommentare“ habe ich noch nie gehört.

Zeilenkommentare werden im Allgemeinen nach dem Code platziert und Blockkommentare werden über dem Code platziert
Einzelheiten finden Sie in der Linkbeschreibung

Wenn Sie ein Formatierungsprogramm oder ähnliches verwenden, hinterlassen Sie am Ende einen einzeiligen Kommentar. Andernfalls formatieren einige Formatierungstools die Dinge etwas seltsam

Bitte schreiben Sie oben Kommentare. Anschließend können allgemein formatierte Kommentare in die API exportiert werden.

Dann gibt es Notizen zum Lesen, also schreiben Sie einfach, was Sie wollen. Niemand außer Ihnen wird Ihre Kommentare sowieso lesen. Dokumentkommentare stehen in der Regel am Anfang. Zufällig geschriebene Kommentare scheinen nutzlos zu sein

Kommentarformat:

1. Einzeilige Kommentare:
//……3. Dokumentkommentare:
/*……*/ 4. Javadoc-Kommentar-Tag-Syntax
/**……*/
Aus persönlicher Projekterfahrung ist es sinnvoll, es wie folgt zu verwenden:

---

1. Variablen werden im Allgemeinen mit einer einzelnen Zeile kommentiert und am Ende der Zeile platziert. Wenn die Variable oder Anmerkung zu lang ist, kann sie auch am Anfang platziert werden Kommentieren Sie stattdessen, je nach Situation;

2. Aufrufmethoden werden im Allgemeinen mit Blöcken versehen und oben platziert

<code>SAXReader reader = new SAXReader();//创建SAXReader
//获取<List>根标签下的所有emp标签
List<Element>elements = root.elements();
/*
 * Element提供了获取中间文本信息的方法：
 * String getText()
 * String getTextTrim()
 */
String name = nameEle.getText();
</code>

Ich habe gesehen, dass jemand jsdoc erwähnt hat, und ich persönlich verwende

<code>/* 读取XML文件 */
Document doc = xmlFileReader();
</code>

Hier ist ein chinesisches Versionsdokument von jsdoc.

Was Kommentare betrifft, bin ich persönlich der Meinung, dass Zeilenkommentare an der Zeilenposition und Blockkommentare am Zeilenanfang geschrieben werden sollten.

jsdoc
Es ist eine persönliche Gewohnheit!

Normalerweise füge ich den Code in eine separate Zeile oder in mehrere Zeilen ein, wenn der Code zu lang ist oder zu viele Wörter kommentiert werden müssen.

Kurz, ähnlich wie bei Ihnen, fügen Sie es einfach hinter den Code ein.

Auch gewöhnlich leer eingeben:

.

//Je nach persönlichen Gewohnheiten ist es besser, es später zu sagen

Ich persönlich denke, dass es für Kommentare drei Prioritäten geben sollte: Die Spezifikation der Projektanforderungen ist die höchste Ebene. Wenn das Projekt keine Anforderungen hat, befolgen Sie die offiziellen Standards. Wenn es keine offiziellen Standards gibt, befolgen Sie Ihre eigenen Standards. . Bezüglich Ihrer eigenen Standards zitiere ich oben eine Antwort: „Kommentieren Sie nicht um der Kommentare willen.“ Der Zweck von Kommentaren besteht darin, komplexen Code klar und verständlich zu machen

Schauen Sie sich persönliche Gewohnheiten oder Teamgewohnheiten an.

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就用#或者""""""，最好跟规范走

习惯......