HTML 및 CSS 의견은 얼마나 좋습니까?-CSS 튜토리얼-php.cn

HTML 및 CSS 의견은 얼마나 좋습니까? 기본 HTML 또는 CSS에 대해 배우기 시작할 때 일반적으로 배우는 것 중 하나는 코드에 주석을 작성하는 방법입니다. 그러나 많은 웹 개발자는 여전히 자신의 유리한 의견을 사용하지 않습니다. 우리는 HTML과 CSS에서 댓글을 널리 사용할 수 있지만, 제대로 작성되고 의도적으로 워크 플로를 개선 할 수 있습니다. . 새 회사에서 일을 시작할 때 매뉴얼 또는 많은 페이지를 보는 것은 어려울 수 있습니다. 모든 회사는 다릅니다. 즉, 코드베이스, 레거시 코드의 양, 프레임 워크 개발 및 모듈 식 코드의 양이 다를 수 있음을 의미합니다. 우리는 종종“좋은 코드가 댓글이 필요하지 않다”고 말하지만, 당신은 의

로 인해 서클에서 돌아 다니며 완전히 잃어 버리고 문서를 찾는 적이 있습니까?

키 테이크 아웃

HTML 및 CSS에서 댓글을 달면 일관성을 이해하고 일관성을 유지할뿐만 아니라 개발 프로세스 속도를 높이고 효율적인 협업을 지원합니다. 여러 개발자가 같은 프로젝트를 진행하는 팀 환경에서 특히 도움이됩니다.

댓글이 유익하지만 과잉을 피하십시오. 모든 코드 블록을 주석하면 중복되고 시간이 많이 걸릴 수 있습니다. 주석은 간결해야하며 코드가 완전히 명확하지 않은 곳에서만 사용해야합니다. 의견을 사용하여 의사 요소의 목적, 중첩 코드 블록, 왜! 중요한지, 또는 코드 블록이 삭제되지 않고 댓글을 달린 이유를 설명 할 수 있습니다. 커밋 메시지 및 풀 요청과 같은 다른 형태의 문서도 개발 프로세스의 일부로 간주되어야합니다. 그들은 맥락과 명확성을 제공하여 협업 및 코드 검토를보다 효율적으로 만듭니다.

코드 댓글에 대한 두 가지 사실

댓글은 브라우저에서 무시됩니다 댓글은 미니 화 중에 제거됩니다

이 두 가지 사실을 바탕으로, 우리는 의견이 실제로 기계를위한 것이 아니라는 것을 알고 있습니다. 인간이 를 읽는

 댓글 코드가 중요한 이유 
<fr> 당신이 프리 랜싱을하고 솔로 프로젝트를 진행할 때, 또는 코드를 볼 수있는 유일한 개발자 일 때, 자신의 방식으로 쉽게 갈 수 있고, 적합한대로 댓글을 작성하는 것은 쉽습니다. 전혀 의견을 남기지 마십시오. 그러나 많은 시간 동안 개발자들은 자신의 코드를 되돌아보고“내가 어떻게 생각 했는가?”라고 궁금해한다고 말합니다. 또는 그들이 작성한 코드를 이해하기 위해 고군분투합니다. </fr>

의견은 일관성을 유지하는 데 도움이 될 수 있습니다. 당신이 만들고있는 것에 대한 일관되고 잘 쓰여진 의견이 있다면 매번 같은 방식으로 물건을 만들 가능성이 높습니다.

. 의견은 이해를 용이하게합니다. 이것은 때때로 한 사람이 모든 일을하지 않는 팀에서 정말 중요합니다. 당신은 자신이 몇 가지 논리를 알아내는 데 도움이되는 의견을 작성할 수 있으며, 프로젝트가 끝날 때까지 모든 의견을 유지하지 않더라도 솔루션에 대한 방법을 더 잘 이해하는 데 도움이 될 수 있습니다. 나중에 해당 솔루션을 훨씬 쉽게 개선하는 데 도움이 될 수 있습니다.

댓글은 핫픽스 또는 빠른 수정에 도움이 될 수 있습니다. 의견은 실제로 세 가지 방법으로 도움이 될 수 있습니다. 그들은 빠른 수정을 해야하는 경우 개발자가 코드를 이해하는 데 도움이 될 수 있습니다 (특히 프론트 엔드 팀 이외의 개발자가 도움을 줄 수있는 개발자). 적용되었고 어느 시점에서 제거해야합니다.

의견은 개발 과정의 속도를 높이는 데 도움이됩니다. 관련 주석을 포함시킬 경우 작성, 변경 또는 제거에 대한 명확한 이해를 가질 수 있습니다.

의견은보다 효율적인 협업을 용이하게합니다. 프로젝트 나 코드베이스의 내부를 알고 있다면, 비트와 조각이 더 빨리 끝날 가능성이 높아 워크 플로가 향상됩니다.

. 의견은 많은 사람들을 돕습니다. 그들은 자신을 도울뿐만 아니라 팀의 다른 사람들을 도울 수 있습니다. 사람들의 소스 코드에서 내 코드를 훔치지 않는 것처럼 의견을 보았던 시대는 지났습니다. 우리는 코드를 매우 보호했지만 '비밀'을 공유하고 싶지는 않았지만 이제는 사람들이 코드를 공유하고 프로젝트를 함께 일하고 협력하는 세상에 살고 있습니다. 우리는 웹 프로젝트와 관련하여 Harry Roberts, Chris Coyier 또는 Jonathan Snook와 같은 사람들을 부끄러워하지 않습니다. 이러한 협력 변화로 인해 우리는 논평 관행을 주목하고 동료들을 도와야합니다.

주석에 관해서는 피해야 할 몇 가지 사항

모든 것을 절대적으로 댓글을 달리지 마십시오

모든 코드 블록에 댓글을 달아야하는 습관을 들고 싶을 수도 있지만 유용하거나 유용한 것보다 더 중복 될 수 있습니다. 댓글은 무언가가 완전히 명확하지 않은 경우에만 수행해야합니다. 수업의 이름을 지정할 때 의미론을 고려한 경우 코드는 이미 이해하기 쉬울 수 있습니다.

. 이것은 또한“좋은 코드가 필요하지 않은 댓글”의 개념이 나온 곳 일 수도 있습니다. 의견을 완전히 피해서는 안되지만 필요한 경우에만 사용됩니다.

너무 장황하지 마십시오 나는 개인적으로 CSS에 다소 긴 의견을 쓰는 것에 대해 유죄입니다. 그러나 소설을 쓰지 않아야합니다. 긴 의견은 글을 쓸 수있는 한 읽는 것이 고통 스럽습니다. 간결 할 수 있다면 그렇게하십시오. 때로는 CSS 클래스의 이름을 지정할 때 다음과 같은 조언이 제공됩니다.

클래스 이름을 가능한 한 짧지 만 필요한만큼 길게 만듭니다. 동일하게 주석에 적용됩니다. 자신이 직접 이해하도록하는 의견을 읽는 것이 좋습니다. 당신이 코드를 처음 접하고 안내서로 주석을 읽고 있다고 상상해보십시오.

주석을 쓰는 데 너무 많은 시간을 소비하지 마십시오 나는 한 번 프로젝트에서 파일을 보았습니다.

의견을 쓰는 데 많은 시간을 할애 할 필요가 없습니다. 몇 마디로는 일반적으로 충분합니다. 코드를 댓글을 달아 다른 사람이 다른 사람이 이해할 수 있도록 너무 많은 시간을 소비하는 경우, 코드의 일부가 실제로 리팩토링이 필요할 수 있음을 고려하십시오.

. 주석을 사용하는시기의 일부 예

의사 요소의 목적을 설명하려면

이 예제는 내용 값이 채워진 의사 요소를 보여줍니다.

특히 콘텐츠 속성이 내용으로 표시되는 경우 의사 요소가 무엇인지 즉시 명확하지 않을 수 있습니다. ''. 코드 블록 위의 짧은 주석으로 우리는 이것을 개선 할 수 있습니다.

<span>// Update this with how many hours you have spent on this file:
</span><span>// TIME_WASTED = 438;</span>

로그인 후 복사

중첩 코드 블록을 설명하려면 가능한 한 의미 론적 클래스를 사용하는 것이 확실히 도움이되지만, 사전 프로세서를 사용할 때 CSS 블록이 중첩되는 이유는 항상 명확하지 않을 수 있습니다.

6 단어는이 코드 블록이하는 일을 나타내는 주석으로 충분하며, 누군가가 문서를 훑어보고 앞으로 중지하거나 건너 뛸 수있게 해줍니다.

.

이유를 설명하려면! 중요한 것이 필요할 수 있습니다 우리는 자주보고 있습니다! 중요하고 우리가 레거시 코드 나 더러운 해킹을보고 있다고 가정합니다 :

면밀한 검사시 프레임 워크의 기본 동작을 무시하고 있습니다.

코드 블록이 단순히 삭제되지 않고 댓글을 달린 이유를 설명합니다. 아래 코드 블록을 보면 이것이 괜찮다고 가정 할 수 있습니다. 확실히 어디서나 사용되지 않습니까? 내가 삭제하면 나중에 필요할 때 어쨌든 버전 제어에있을 것입니다.

~~그러나 우리가 삭제하면 누군가가 처음에 존재한다는 것을 알지 못할 수도 있습니다. 이것을 여기에 두는 것이 좋은 생각 일 것입니다 :~~

<span><span>.post__comment-container::after</span> {
</span>  <span>background-color: #f9f9f9;
</span>  <span>border: 1px solid #dedede;
</span>  <span>border-radius: 0.25em;
</span>  <span>color: #888;
</span>  <span>content: 'Post author';
</span>  <span>display: inline-block;
</span>  <span>font-size: 0.7rem;
</span>  <span>margin-left: 0.5rem;
</span>  <span>padding: 0.2rem 0.45rem;
</span>  <span>vertical-align: middle;
</span><span>}</span>

로그인 후 복사

기타 종류의 문서 문서는 코드의 주석에만 국한된 것이 아니라 실제로 중요합니다. 작업을 마치면 동료를 검토 할 수 있습니다.

커밋 메시지 버전 컨트롤 (예 : git)을 사용할 때 코드에 유용한 의견을 작성하는 것에 대해 알고있는 것을 취하고 커밋 메시지에 적용 할 수 있습니다. 나쁜 커밋 메시지는 많은 맥락을 제공하지 않습니다. 그들은 조잡 해 보이고 이해하기 어려울 수 있습니다. 그들은 릴리스 노트에 도움이되지 않습니다. 개발자가 무엇이 바뀌 었는지 알기가 어려울 수 있습니다. 나쁜 커밋 메시지는 종종 이렇게 보입니다.

/* Post author label for comment */

<span><span>.post__comment-container::after</span> {
</span>  <span>background-color: #f9f9f9;
</span>  <span>border: 1px solid #dedede;
</span>  <span>border-radius: 0.25em;
</span>  <span>color: #888;
</span>  <span>content: 'Post author';
</span>  <span>display: inline-block;
</span>  <span>font-size: 0.7rem;
</span>  <span>margin-left: 0.5rem;
</span>  <span>padding: 0.2rem 0.45rem;
</span>  <span>vertical-align: middle;
</span><span>}</span>

로그인 후 복사

더 나은 예는 동사를 사용하여 커밋에서 완료된 작업을 설명합니다. 다른 커밋에 따라 다른 사소한 작업이 퍼질 것입니다.

<span>// Update this with how many hours you have spent on this file:
</span><span>// TIME_WASTED = 438;</span>

로그인 후 복사

카르마는 더 나은 커밋을 작성하는 데 매우 간단한 가이드를 가지고있는 반면 Chris Beams는 매우 심층적 인 가이드가 있습니다. David Demaree는 심지어 '커밋의 예술'이라는 제목의 기사를 썼습니다. 커밋 메시지는 확실히 약간의 관심을받을 자격이 있습니다.

요청을 당기는 요청 소수의 커밋을 작성한 후에는 일반적으로 동료 중 한 명이 볼 수있는 풀 요청을 만듭니다. 세부 사항이 거의 없거나 설명이 전혀없는 너무 많은 풀 요청을 보았습니다.

풀 요청을 작성할 때 일반적으로 누군가가 코드를 검토 할 것을 기대합니다. 그 사람을 돕고 프로세스를 완화하기 위해 풀 요청에 포함 된 내용에 대한 설명을 작성해야합니다. 이것은 내 정신 체크리스트입니다 :

티켓 번호, 작업 번호 또는 문제 번호 몇 마디로 작업을 언급하십시오 내가 어떤 유형의 파일을 변경했는지 언급하십시오 버그라면, 변화 전후 버그가 어떤지 언급하십시오 변경 후 예상되는 동작을 설명합니다 (동일해야합니까?)

브라우저 또는 코드에서 변경 사항을 확인하기 위해 취해야 할 단계를 나열하십시오. 예를 들어 다른 지점에서 다루어진 버그를 무시 해야하는 모든 것을 확인하십시오. 는 필요에 따라 인터페이스의 스크린 샷을 포함시킵니다

이 예제는 비교적 간단하며 필요하지 않은 경우 위 목록에 모든 것을 포함시킬 필요는 없습니다. HTML 및 CSS 의견은 얼마나 좋습니까?

결론

피해야 할 사항에 대한 의견과 의견을 포함시킬 수있는 몇 가지 예를 제공했지만 코드에서 의견을 작성하는 방법에 대한 어려운 규칙은 없습니다. 줄, 단어 또는 포함해야 할 정보는 귀하에게 달려 있거나 귀하와 동료 사이에서 결정될 수 있습니다. 형식을 일관성있게 유지하는 한, 그것은 단정을 유지하고 코드로 작업하는 다른 사람들이 같은 일을하도록 장려합니다. 개발 프로세스의 일부로 의견을 제시하는 것과 관련된 많은 이점이 있습니다. 특히 많은 사람들이 같은 파일을 작업 할 때 적합한 곳에 포함시키는 습관에 들어가는 것이 좋습니다. 또한 단순히 지침의 외부 문서가 아니라 커밋 메시지 및 풀 요청과 같은 워크 플로에 포함 된 다른 형태의 문서를 고려하는 데 도움이됩니다. 주석 코드에 대한 지침을 따르나요? 아니면 다르지만 효과적인 문서를 가지고있는 회사에서 일할 수도 있습니까?

html 및 css 댓글에 대한 자주 묻는 질문 (FAQ) html 및 css에서 주석을 사용하는 것이 중요합니까?

HTML 및 CSS의 의견은 몇 가지 이유로 중요합니다. 첫째, 특히 팀에서 일하거나 오랜 시간이 지난 후 코드를 다시 방문 할 때 코드 구조 및 기능을 이해하는 데 도움이됩니다. 둘째, 디버깅 중에 코드의 특정 부분을 일시적으로 비활성화하는 데 사용될 수 있습니다. 마지막으로 코드를 읽는 사람에게 유용한 정보 나 지침을 제공 할 수 있습니다.

html 및 css에서 코드를 주석을주는 방법?

HTML에서는 코드를 마무리하여 코드를 rapping하여 코드를 댓글을 달 수 있습니다.

. 예를 들어,

. CSS에서, 텍스트를 /*와 /사이에 래핑하여 주석이 이루어집니다. 예를 들어, / 이것은 주석 * /.

내 웹 사이트의 성능에 영향을 줄 수 있습니까?

아니요, 주석은 웹 사이트의 성능에 영향을 미치지 않습니다. 렌더링 프로세스 중에 브라우저에 의해 무시됩니다. 그러나 과도한 주석은 파일 크기를 증가시킬 수 있으며, 이는 로딩 시간에 약간 영향을 줄 수 있습니다. HTML 및 CSS에 의견을 작성하는 모범 사례는 무엇입니까? 의견을 작성하기위한 일부 모범 사례에는 포함됩니다. 간결하면서도 설명적이고, 복잡하거나 중요한 코드 섹션에 대해 의견을 말하며, 불필요하거나 중복 된 의견을 피합니다. 코드의 변경 사항을 반영하기 위해 의견을 정기적으로 업데이트하는 것도 좋은 관행입니다.

주석을 사용하여 특정 브라우저에서 코드를 숨기려면 코드를 사용하여 코드를 숨기는 데 사용될 수 있습니다. 특정 브라우저. 조건부 주석으로 알려진이 기술은 종종 다른 버전의 인터넷 익스플로러에 대한 다양한 스타일이나 스크립트를 제공하는 데 사용됩니다.

디버깅에 주석을 어떻게 사용할 수 있습니까?

주석을 디버깅에 사용할 수 있습니다. 코드의 특정 부분을 일시적으로 비활성화함으로써. 이를 통해 코드의 문제가있는 섹션을 분리하고 식별하는 데 도움이 될 수 있습니다.

html 및 css에서 주석을 둥지에 빠질 수 있습니까?

html에서는 주석을들을 수 없습니다. 그렇게하려고하면 예상치 못한 결과가 발생할 수 있습니다. CSS에서는 의견을들을 수 있지만 코드를 읽고 이해하기가 더 어려워지기 때문에 일반적으로 권장되지 않습니다.

단일 라인과 멀티 라인 댓글의 차이점은 무엇입니까?

단일 라인 댓글은 짧은 설명이나 주석에 사용되며 멀티 라인 주석은 더 긴 설명이나 코드 블록에 사용됩니다. HTML에서 모든 의견은 기술적으로 멀티 라인입니다. CSS에서 단일 라인 주석은 //부터 시작하여 줄 끝에서 끝나고, 멀티 라인 댓글은 / *로 시작하여 * /.

내 주석에 특수 문자를 사용할 수 있습니까?