[Tips] Use Xcode's Integrated HeaderDoc to automatically generate comments and development documents

Doxygen is a good tool, but I feel that in mac systems, if the CHM file generated by doxygen is not that appropriate, it should be because CHM itself is a Microsoft product, it is not very common on the Apple system, and file garbled characters often occur. At this time, the CHM is better than the PDF and RTF files. In fact, the direct html file is also good.

Are there any other alternatives on mac. I paid special attention to it and found that the powerful functions of xcode were not used properly in the past.

HeaderDocTools

HeaderDoc is an open-source tool that is integrated into Xcode. It is also very powerful that you do not need to care about the format of annotations, or you can customize the format and resolution of annotations.

To add a comment, first select the code for the comment to be added. The default function syntax requires a space after the +/-sign and the function name. Select the comment of the corresponding type to be inserted and add instructions. You do not need to write them one by one.

All Class header protocols are supported.

650) this. width = 650; "title =" clip_image002 [5] "style =" border-top-0px; border-left-width: 0px; border-bottom-width: 0px; border-right-width: 0px "height =" 309 "alt =" clip_image002 [5] "src =" http://www.bkjia.com/uploads/allimg/131228/1G13La7-0.jpg "width =" 558 "border =" 0 "/>

650) this. width = 650; "title =" clip_image004 [4] "style =" border-top-0px; border-left-width: 0px; border-bottom-width: 0px; border-right-width: 0px "height =" 363 "alt =" clip_image004 [4] "src =" http://www.bkjia.com/uploads/allimg/131228/1G13Mb7-1.jpg "width =" 558 "border =" 0 "/>

If you know how to write a script, you can even customize the annotation of the desired type. For example, if there is no property annotation by default, you can write one by yourself. You can also customize shortcut keys for easy operation.

650) this. width = 650; "title =" clip_image006 [5] "style =" border-top-0px; border-left-width: 0px; border-bottom-width: 0px; border-right-width: 0px "height =" 322 "alt =" clip_image006 [5] "src =" http://www.bkjia.com/uploads/allimg/131228/1G13J0C-2.jpg "width =" 558 "border =" 0 "/>

The comments are written. This is to generate available help documents.

Document Generation Method

Use the terminal to enter the folder where the header file is located,

Headerdoc2html-o outputDir ExampleHeaders

Gatherheaderdoc outpitDir TOC. Html

OutputDir is the name of the folder that saves html, ExampleHeaders is the place where the header file is saved, and TOC. Html is the generated file name, which can be modified.

After running the command, you can find TOC. Html in the directory, and the file will have the same document as Cocoa API Docments. Although it is still Html.

650) this. width = 650; "title =" clip_image008 [4] "style =" border-top-0px; border-left-width: 0px; border-bottom-width: 0px; border-right-width: 0px "height =" 651 "alt =" clip_image008 [4] "src =" http://www.bkjia.com/uploads/allimg/131228/1G13HX2-3.jpg "width =" 558 "border =" 0 "/>

In fact, there are many advanced settings that support user-defined formats, and Man page Generation extends agempgl) Dialect. For more information, see Apple's official document HeaderDoc user Guide.