Preciso inserir um comentário dentro de um arquivo vue.js para referências futuras, mas não encontro como fazer isso na documentação.
Eu tentei //
, /**/
, {{-- --}}
, e {# #}
, mas nenhum deles parece funcionar.
Estou usando a lâmina do Laravel. Então este é o sample_file.vue
:
<template>
<div class="media">
<like-button :post="post" v-if="post.likedByCurrentUser === false && "></like-button> {{--I want to comment this but I get an error from the gulp watch: post.canBeLikedByCurrentUser === true--}}
<div class="media-left">
<a href="#">
<img class="media-object" v-bind:src="post.user.avatar" v-bind:title="post.user.name + ' image from Gravatar'">
</a>
</div>
<div class="media-body">
<strong>{{ post.user.name }}</strong>
<p>{{post.body}}</p>
<p>{{post.likeCount}} {{ pluralize('like', post.likeCount) }}</p>
</div>
</div>
</template>
Alguém sabe inserir um comentário e / ou comentar trechos de código?
vue.js
blade
laravel-blade
Pathros
fonte
fonte
<!-- -->
. Mas parece que você está procurando comentários embutidos?HTML
código! Thnx{{! comments like this }}
e{{!-- comments {{like this}} that can contain double-braces --}}
. Eles não são renderizados na saída, ao contrário de<!-- html comments -->
quais são. Tentei os dois{{! ... }}
e{{!-- ... --}}
com o Vue, mas infelizmente não são compatíveis. Você consideraria adicioná-los à sua pergunta para os usuários que toparem com ela?Respostas:
Você gostaria de usar comentários HTML padrão na
<template>
tag em sua situação. Eles serão retirados da saída também, o que é bom.fonte
Como disse Bill Criswell, podemos usar a sintaxe de comentário HTML.
Mas também funcionará fora da tag template, comment.vue
fonte
<comment>Commenting here</comment
. Você terá que adicioná-los à configuração do seu webpack. vue-loader.vuejs.org/guide/custom-blocks.html#exampleAcabei de testar isto:
fonte
Error parsing JavaScript expression: Unexpected token (1:24)
Percebi que você não pode comentar quando está dentro de uma tag:
fonte
Se for útil para seus projetos, você pode colocar texto simples acima do modelo, sem adornos. Ele é completamente ignorado quando você renderiza seu componente.
fonte
O Vue Styleguidist contém as melhores práticas e mostra exemplos de como comentar seus componentes. https://vue-styleguidist.github.io/docs/Documenting.html#code-comments
Mas em geral...
No modelo ou na seção HTML, use comentários HTML
Na seção de script , use comentários de Javascript
Na seção de estilo , use comentários CSS
fonte
A dica a seguir não é tanto sobre comentar (como documentar) o código em si, mas sim sobre permitir que você ignore temporariamente partes do código durante o desenvolvimento.
Quando os comentários exigem a abertura e o fechamento de tags, a maneira como o analisador os corresponde pode ser inconveniente. Por exemplo o seguinte
irá produzir
and that -->
. Da mesma forma/* this will be commented /* and so will this */ but not this */
.Minha solução é usar
v-if="false"
para especificar quais blocos eu quero (temporariamente) pular.Observe que isso não deve ser usado em substituição aos comentários adequados para documentar seu código. É apenas uma maneira conveniente de ter mais controle sobre os blocos que deseja pular durante o desenvolvimento.
fonte
Eu sou novato no Vue.js, mas
//
deve funcionar porque o código é javascript mesmo assim. Olhando na documentação encontro este exemplo . Se você olhar as 2 primeiras linhas do javascript, verá comentários com//
.exemplo em arquivo vinculado a javascript:
fonte
template
tag, mas dentro dascript
tag