<commit_before><commit_msg>2017-08-04 16:23:39.499051<commit_after>---
layout: post
title: "代码注释工具 Doxygen""
category: 工具链
tags:
    效率工具链
keywords:
description:
---


## Intro
There are various [comment styles](http://rigaux.org/language-study/syntax-across-languages/Vrs.html#VrsCmmnt)

```
sudo apt-get install doxygen

```


## Usage Steps
1. generate config file(use doxywizard)
```
doxygen -g
```
2. Coding with the standard doxygen comment style

3. generation
```
doxygen Doxyfile
```
4. open generate doxygen style html
```
index.html
```

## GUI Guidence
![]({{site.zhehua.images}}/Toolchain/Doxygen/doxygen_config1.png)
![]({{site.zhehua.images}}/Toolchain/Doxygen/doxygen_config2.png)
![]({{site.zhehua.images}}/Toolchain/Doxygen/doxygen_config3.png)
![]({{site.zhehua.images}}/Toolchain/Doxygen/doxygen_config4.png)
![]({{site.zhehua.images}}/Toolchain/Doxygen/doxygen_config5.png)




{'fraction_non_alphanumeric': 0.17371937639198218, 'fraction_numerical': 0.03229398663697105, 'mean_word_length': 5.330985915492958, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '7043434', 'n_tokens_mistral': 397, 'n_tokens_neox': 340, 'n_words': 58}