Documentación SDK

Los SDK deben ser adoptados por otros desarrolladores y, como colaborador, nadie sabe mejor que usted cómo funciona un SDK determinado. Ayude a otros y difunda el uso de la documentación de escritura SDK.

Léame

Asegúrese de que el LÉAME tenga las siguientes secciones.

  • Requisitos

  • Instalación

  • Contribuyendo

  • Licencia

Template: README

Comentarios y documentos de referencia

Document functions and classes with comments while you write your code. A reference generator should be able to read these comments and generate HTML as an output.

Some examples of reference generators are TypeDoc for Javascript, whereas in Java, we are using Javadoc.

We recommend you to research and determine which is the reference generator most convenient for the selected programming language.

Guías

El Bitxor Developer Documentation reúne una colección de guías. Estas guías muestran a los desarrolladores cómo usar Bitxor características integradas mientras sigue los casos de uso paso a paso. Cada guía viene con al menos un fragmento, que es un fragmento de código ejecutable que resuelve el caso de uso propuesto.

Escribir fragmentos lo ayuda a comparar cómo se ve el código SDK en contraste con otros. Además, probará manualmente si el SDK se comporta correctamente.

  1. Fork and clone symbl-docs repository.

    git clone https://github.com/<YOUR_USERNAME>/bitxor-docs.git

  2. Cree una nueva carpeta en source/resources/examples/ con el nombre del lenguaje de programación de su SDK.

  3. Adapte cada fragmento de TypeScript usando el nuevo SDK.

  4. Empuje los cambios y cree una solicitud de extracción.