2009-10-09 15 views
26

Lo que realmente me decepciona de Boost es su documentación. Lo que necesito es una buena referencia, y en lugar de explicar lo que es una buena referencia para mí, me gustaría dar un ejemplo:¿Una referencia de Better Boost?

java.sun.com/javase/6/docs/api/ Sí, me encanta. También es la siguiente: cppreference.com/wiki/stl/vector/start

Por otro lado lo que encuentro sobre el impulso es algo como esto: http://www.boost.org/doc/libs/1_40_0/libs/smart_ptr/shared_ptr.htm

Básicamente alguna larga página de texto. Casi ningún formato, texto en negrita aquí y allá y con suerte algunos enlaces entre elementos. Sin mencionar que smart_ptr es una de las bibliotecas mejor documentadas.

Si no encuentra la diferencia entre este y los ejemplos anteriores, por favor deje de leer e ignore esta publicación. No me malinterpretes, escribo C++ y uso Boost. En mi empresa usamos al menos 4 de sus bibliotecas, y cada vez que necesito verificar un prototipo de método, por ejemplo, me saca de mis nervios el desplazamiento a través de sus ensayos. Y sí, sé que Boost es un proyecto colaborativo y que diferentes bibliotecas desarrollan diferentes bibliotecas.

¿Alguno de ustedes comparte mi decepción con la referencia de Boost y conoce algún sitio mejor documentando las bibliotecas de Boost?

Respuesta

6

En general, no encuentro la documentación es que malo. En general, nuevamente, la información está "en algún lugar" allí. El principal problema que veo es la falta de uniformidad, lo que dificulta encontrar ese "lugar". Al escribir en su pregunta, los documentos fueron escritos por diferentes personas, y en diferentes momentos, y esa es probablemente la causa de esta falta de una estructura común.

De los enlaces java y cppreference que citan en el ejemplo, deduzco que está más interesado en la sinopsis de la interfaz que en cosas "tutoriales" o de "motivación". Para shared_ptr, ¿proporciona http://www.boost.org/doc/libs/1_40_0/libs/smart_ptr/shared_ptr.htm#Synopsis lo que está buscando?

Para algunas librerías, los directorios "prueba" y "ejemplo" en libs/<library_name> son útiles.

Puede publicar sus preguntas, comentarios y sugerencias en las listas de distribución users y/o documentation. Según lo que veo allí, los encargados de mantenimiento de la biblioteca suelen dar la bienvenida a las sugerencias específicas de mejora de la documentación.

+1

Sí, exactamente. Estoy interesado en una sinopsis similar a la que ha vinculado. Aún así, no pienses que esto es lo suficientemente bueno. –

+0

Eso me hace preguntarme qué tan difícil sería construir una "página de índice" apuntando a las secciones "sinopsis" o "referencia" de los documentos existentes. –

+3

6 años después y tengo el mismo problema. – SuppenGeist

2

Si está buscando un texto introductorio, encontré el libro de Bjorn Karlsson muy bueno. Hace un tiempo, cuando lo leí, puede haber textos más actualizados disponibles ahora. Find it here.

+0

Otra advertencia es que solo se trata de algunas bibliotecas seleccionadas. Pero estoy de acuerdo, es una buena introducción a los que cubre. +1 – sbi

+5

No, exactamente lo contrario. Estoy buscando una referencia, una sinopsis de las clases disponibles con sus métodos. El sitio de Boost es lo suficientemente bueno para un tutorial general. –

0

En cuanto a la relación de Java proporcionado, así más de la mitad de ella es obsoleta desde hace bastante tiempo ahora :)

dispone de herramientas de PDF y PDF de los documentos ahora .. Existen herramientas y más en su manera, desde el libro de ayuda para escritores de lib hace años a la sinopsis y más ... Construya su propio o analice la mayoría existente del costo de marcado a un proyecto ya exagerado :)

1

Estoy definitivamente de acuerdo. Javadoc es desagradable, desagradable. Pero es minucioso y constante en casi todos los proyectos. Compare la capacidad de navegación de una documentación aleatoria del proyecto de Yakarta con la de un proyecto aleatorio de Boost.

Cuestiones relacionadas