Comentarios

Añadir comentarios a las páginas y a las referencias es una forma útil de registrar detalles adicionales y colaborar con los miembros del equipo.

¿Por qué usar comentarios?

Los comentarios te ayudan a debatir cambios con tus compañeros, registrar decisiones y dejar notas para más adelante. Los compañeros a los que etiquetes pueden recibir una notificación automática, de modo que las conversaciones de revisión permanecen asociadas al contenido correspondiente.

Comentarios en páginas

En las páginas de documentación, los comentarios se añaden directamente sobre el texto y quedan anclados al contenido seleccionado.

Añadir un comentario en una página

1. Resalta el texto que quieres comentar.

2. Selecciona Comentar en la barra de herramientas.

3. Escribe tu comentario.

Tu comentario aparecerá en el lado derecho de la página, alineado con el texto que has comentado.

Ver y navegar por los comentarios de una página

• Los comentarios se muestran en una columna a la derecha, junto al contenido de la página.

• Como los comentarios utilizan el lado derecho del diseño, es posible que la tabla de contenidos se oculte mientras los comentarios están visibles.

Opciones de vista

Usa Opciones de vista en la barra lateral derecha para controlar lo que ves:

• Panel del margen: elige qué se muestra en el margen derecho. Esquema (la tabla de contenidos) se muestra de forma predeterminada; cambia a Comentarios para mantener a la vista el hilo de comentarios. Los comentarios toman el control automáticamente cuando hay un hilo abierto.

• Mostrar comentarios resueltos: activa o desactiva la visualización de los comentarios resueltos.

• Notificaciones: define cómo se te notifica la actividad de los comentarios de la página (se explica más abajo).

Comentarios en referencias de API

Las referencias de API siguen admitiendo comentarios asociados a partes concretas de la referencia. Cuando resaltas texto y escribes un comentario, este queda asociado a esa parte exacta de la referencia de API. Los comentarios pueden asociarse a:

• Descripción de la referencia de API

• Esquemas de autenticación

• Servidores

• Etiquetas

• Operaciones

• Solicitudes de operaciones

• Campos en solicitudes de operaciones

• Respuestas de operaciones

• Campos en respuestas de operaciones

Cuando un compañero hace clic en un comentario, se resaltará la parte asociada.

Etiquetar a compañeros

Para etiquetar a tus compañeros en un comentario, empieza escribiendo el carácter @. Se mostrará una lista de todos los compañeros entre los que elegir.

Resolver comentarios

Cuando hayas terminado con un comentario, puedes resolverlo para ocultar sus detalles. Al resolver un comentario se notificará el estado de resolución a los observadores.

Los publicadores y administradores pueden resolver todos los comentarios a la vez.

Puedes configurar Preguntar antes de publicar si quieres publicar solo cuando todos los comentarios estén resueltos.

Notificaciones

Puedes controlar cómo se te notifica la actividad de los comentarios de una página. Abre Opciones de vista en la barra lateral derecha y establece Notificar en uno de estos tres estados:

• En todos los comentarios: eres observador y recibes correos electrónicos con un resumen de cada cambio en los comentarios de la página.

• Cuando se me mencione: el valor predeterminado. Solo se te notifica cuando alguien te etiqueta, y te conviertes automáticamente en observador cuando comentas en la página o te etiquetan en ella.

• Silenciado: no recibes ninguna notificación de la página.

Cuando comentas en una página, o te etiquetan en una, te conviertes en observador de esa página. Para dejar de recibir notificaciones, establece Notificar en Silenciado; para volver a seguirlo todo, establécelo en En todos los comentarios.

También puedes cancelar la suscripción a todas las notificaciones de actividad desde la configuración de usuario.