¿Cómo decorar los métodos de Objective C con documentación?

Question

Cuando escribo un objeto Cocoa y llamo a un selector sobre ese objeto, a veces puedo ver información de 'documentación' o 'ayuda' sobre ese método. Por ejemplo, cuando escribo [NSArray alloc], veo dos sugerencias de ayuda. Uno para NSArray, y otro para alloc. Ambos aparecen en el cuadro de lista de sugerencias de autocompletar emergente mientras escribo el código.

¿Cómo puedo producir consejos de ayuda decorados con métodos/clases similares que aparecerán cuando escribo? Quiero ver mis comentarios mientras escribo mi nombre de clase personalizado y los métodos personalizados. ¿Cómo puedo hacer esto?

Por ejemplo, C# proporciona esta característica a través de la documentación XML que se puede colocar antes de cualquier método, clase o declaración de interfaz/protocolo.

Answer 1

Tienes que crear un "docset". Hay herramientas como appledoc para crear documentos a partir de sus comentarios. Puede configurar una fase de compilación que ejecute appledoc en su código.

El problema es que no hay forma de hacer que Xcode 4 vuelva a cargar un documento excepto reiniciando Xcode. Por lo tanto, incluso si ejecuta appledoc automáticamente como parte de su compilación, deberá reiniciar Xcode para que vea los cambios en su docset.