# AnnotationsForReadme

**Repository Path**: cs-open-project/annotations-for-readme

## Basic Information

- **Project Name**: AnnotationsForReadme
- **Description**: 根据包/类/方法注解，生成markdown格式的README文件，保证代码/路径/文档的一致性。maven 引用可用 github maven仓库（https://github.com/xliuqq/maven-repository）
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-12-22
- **Last Updated**: 2025-03-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 根据注解生成文档

## annotations 工程

定义相关注解，和代码生成

## maven_plugins 工程

maven 插件

## 使用

### 单 maven 工程

> 可参考[数据结构和算法工程](https://gitee.com/oscsc/data-structure-and-algorithm)使用。

```xml
<dependencies>
    <dependency>
        <groupId>org.xliu.cs.projects</groupId>
        <artifactId>annotations-readme-core</artifactId>
        <version>${newest.version}</version>
    </dependency>
</dependencies>

<build>
    <plugins>
        <plugin>
            <groupId>org.xliu.cs.projects</groupId>
            <artifactId>annotations-readme-maven-plugin</artifactId>
            <version>${newest.version}</version>
            <executions>
                <execution>
                    <goals>
                        <goal>generate-doc</goal>
                    </goals>
                    <configuration>
                        <scanPkgPrefix>org.xliu.cs.algs_ds</scanPkgPrefix>
                        <outputFilePath>${project.basedir}/README.md</outputFilePath>
                    </configuration>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>
```

### 多 maven 工程

> 可参考[JVM知识](https://gitee.com/oscsc/jvm)使用。
> 
子工程：
- 参考单工程，根据源码注解生成 README.md

父工程：
- 父工程的 pom.xml 文件中需要定义 `<descrpition></description>`，用作父工程的标题；
- 子工程的 pom.xml 文件中需要定义 `<descrpition></description>`，用作父工程的内容；