Documento personalizado Marco XCode

De hecho, estoy creando un marco para iOS / OSX y me gustaría documentar mis methods públicos como lo hace Apple.

Por ejemplo, supongamos que tengo el método doSomething: … me gustaría recibir la descripción "¡Haz algo muy interesante!" en el panel de autocompletado de XCode.

Este es un ejemplo del resultado deseado:

introduzca la descripción de la imagen aquí

es posible?

Si agrega comentarios con una syntax específica en su código, se convertirá en documentation.

Lea este artículo sobre NSHipster .

Puede agregar comentarios de documento en la statement de método:

 /** * Summary of the method. * * @param firstParam This affects what the method does. * @param secondParam And so does this! * * @return Something very interesting. */ 

Referencia