javascript - 한 줄 주석을 줄 끝이나 코드 위에 배치해야 합니까?

한 줄 주석을 추가해야 하는 경우 개발자는 일반적으로 한 줄 주석을 코드 줄 끝에 배치하거나 단독으로 배치합니다. 코드 위에 줄? 아니면 구체적인 상황과 상세한 분석인가? 개인적인 습관인가요, 아니면 이유가 있는 건가요? 제가 더 많은 것을 배울 수 있도록 모두가 토론할 수 있기를 바랍니다.

• 줄 끝

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

• 위

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

답글 내용:

한 줄 주석을 추가해야 하는 경우 개발자는 일반적으로 한 줄 주석을 코드 줄 끝에 배치하거나 단독으로 배치합니다. 코드 위에 줄? 아니면 구체적인 상황과 상세한 분석인가? 개인적인 습관인가요, 아니면 이유가 있는 건가요? 제가 더 많은 것을 배울 수 있도록 모두가 토론할 수 있기를 바랍니다.

• 줄 끝

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

• 위

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

일반적으로 내 습관은 다음과 같습니다.
1. 변수 선언이나 초기화를 오른쪽에 배치합니다
2. 짧은 코드 블록 선언을 맨 위에 배치합니다
3. 주석이 다음과 같은 경우 여러 줄 주석을 사용합니다. 너무 길어서 위에 배치하세요

핵심은 주석을 달기 위해 주석을 달지 마세요. 변수, 함수 등의 이름은 코드가 명확하게 이해될 수 있도록 표준화되어야 합니다. 결국 '코드의 아름다움'은 있지만 '댓글의 아름다움'은 들어본 적이 없습니다.

라인 주석은 일반적으로 코드 뒤에 배치되고, 블록 주석은 코드 위에 배치되는 것이 일반적입니다.
자세한 내용은 링크 설명을 참조하세요

포맷터 등을 사용하는 경우 끝에 한 줄 주석을 남겨두세요. 그렇지 않으면 일부 서식 지정 도구의 서식이 약간 이상해집니다.

위에 댓글을 적어주세요. 그런 다음 일반적으로 형식이 지정된 주석을 API로 내보낼 수 있습니다.

그 다음에는 읽어야 할 메모가 있으니 원하는 대로 적으시면 됩니다. 어차피 당신 외에는 누구도 당신의 댓글을 읽지 않을 것입니다. 문서 주석은 일반적으로 맨 위에 있습니다. 무작위로 쓴 댓글은 쓸모가 없을 것 같습니다

댓글 형식:
1. 한 줄 댓글: //……
2. 블록 댓글: /*……*/
3. 문서 댓글: /**……*/
4. Javadoc 댓글 태그 구문

---

개인 프로젝트 경험상 다음과 같이 활용하면 깔끔합니다.

1. 변수는 일반적으로 한 줄로 주석 처리되며, 변수나 주석이 너무 길면 맨 위에 배치할 수도 있습니다. 상황에 따라 댓글을 달아주세요.

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

2. 호출 방법은 일반적으로 블록으로 주석을 달고 맨 위에 배치됩니다.

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

누군가 jsdoc을 언급한 것을 보았는데, 제가 개인적으로

를 사용하고 있습니다. 여기 jsdoc 중국어 버전 문서가 있습니다. jsdoc 코멘트에 관해서는, 라인 코멘트는 라인 위치에 작성하고, 블록 코멘트는 라인의 시작 부분에 작성해야 한다고 개인적으로 생각합니다.

익숙해지세요!

저는 보통 코드가 너무 길거나 주석을 달아야 할 단어가 너무 많으면 한 줄에 넣거나, 몇 줄에 넣습니다.

짧고 비슷합니다. 코드 뒤에 넣으세요.

상습적으로 공백을 입력해도:

. //

개인 습관에 따라 나중에 넣는 것이 좋습니다

개인적으로 의견에는 세 가지 우선순위가 있어야 한다고 생각합니다. 프로젝트 요구 사항 사양이 가장 높은 수준입니다. 프로젝트에 요구 사항이 없으면 공식 표준이 없으면 자체 표준을 따릅니다. . 여러분의 기준에 대해서는 위의 답변을 인용하겠습니다: "댓글을 위해 댓글을 달지 마세요." 댓글의 목적은 복잡한 코드를 명확하고 이해하기 쉽게 만드는 것입니다

개인 습관이나 팀 습관을 살펴보세요.

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

习惯......