mozilla

Comparar revisiones

Escribiendo documentación de referencia de la interfaz

Change Revisions

Revisión 363231:

Revisión 363231 de maedca el

Revisión 380895:

Revisión 380895 de Aligo el

Título:
Writing interface reference documentation
Writing interface reference documentation
Enlace amigable (slug):
Project:en/Project:Writing_interface_reference_documentation
Project:en/Project:Writing_interface_reference_documentation
Contenido:

Revisión 363231
Revisión 380895
n11      This article demonstrates how to create properly-formatted n11      Este artículo muestra como crear documentación para interfa
>and useful documentation for interfaces. Each interface should be>ces útiles y correctamente formateada. Cada interfaz debería
> documented in its own article, with the article's title being th> estar documentado en su propio artículo, y siendo el título del 
>e name of the interface.>artículo el nombre del interfaz.
n14      Learn by examplen14      Aprender mediante el ejemplo
n17      See our <a href="/en-US/docs/Project:Sample_interface_documn17      Echa un vistazo a nuestro <a href="/en-US/docs/Project:Samp
>ent" title="Project:Sample_interface_document">sample interface d>le_interface_document" title="Project:Sample_interface_document">
>ocument</a> for a fictional interface that implements all the fea>documento de muestra de interfaz</a> para ver un interfaz fictici
>tures of a complete interface reference document. This article ca>o que incluye todos los elementos de un completo documento de ref
>n serve as a helpful template when documenting an interface.>erencia de un interfaz. Este artículo puede servir de ejemplo cua
 >ndo se documente un interfaz.
n20      A few real interfaces that abide by this standard include {n20      Hay algunos interfaces reales que observan este estándar, c
>{ interface("nsIFeedProcessor") }}, {{ interface("nsIFeedContaine>omo por ejemplo&nbsp;{{ interface("nsIFeedProcessor") }}, {{ inte
>r") }}, {{ interface("nsIFeedTextConstruct") }}, and {{ interface>rface("nsIFeedContainer") }}, {{ interface("nsIFeedTextConstruct"
>("nsIScriptableUnescapeHTML") }}.>) }}, y {{ interface("nsIScriptableUnescapeHTML") }}.
n23      Interface reference sectionsn23      Sección de referencia del interfaz
t26      Each interface reference article has at least an introductit26      Cada artículo de referencia del interfaz tiene al menos una
>on section (which has no heading). The introduction should provid> sección de introducción (que no tiene título o encabezado). La i
>e an overview of what the interface is used for.>ntroducción debería aportar una visión de la utilidad del interfa
 >z.

Volver al historial