# Tiecode-Lombok

**Repository Path**: scave/Tiecode-Lombok

## Basic Information

- **Project Name**: Tiecode-Lombok
- **Description**: 结绳代码辅助器，提供多种注解，减少你的代码量
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 3
- **Forks**: 0
- **Created**: 2023-10-28
- **Last Updated**: 2024-03-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# TiecodeLombok——结绳代码辅助器
## 结绳中文系列项目自动生成代码插件，目前提供10个注解属性，所有属性都可以叠加使用
### 数据模型类
该属性用于指定类为数据模型类，会对类中所有非静态变量生成属性读写方法，并将所有变量隐藏
示例：
```java
@数据模型类
类 学生
  变量 姓名 : 文本
结束 类
```
### 等值对象类
该属性只能用于目标平台为JVM平台的工程中，被标注的类中会自动覆盖JVM类中的hashCode和equals方法
示例：
```java
@等值对象类
类 学生
  变量 姓名 : 文本
结束 类
```
### 序列化类
该属性只能用于目标平台为JVM平台的工程中，被标注的类中会自动生成序列化ID
示例：
```java
@序列化类
类 学生
  变量 姓名 : 文本
结束 类
```
### 自动清理
该属性标注在变量上，被标注的变量在退出作用域时会自动清理，无需用户自己编写代码去清理
示例：
```java
类 学生
  方法 测试()
    @自动清理
    变量 输入流1 = 文件输入流.从路径创建("")
    //该输入流会自动关闭
  结束 方法
结束 类
```
### 参数输出名
该属性用于指定方法参数的输出名称，该属性的值为文本类型，名称用,进行分割
示例：
```java
类 学生
  @参数输出名("p1,p2") //参数a输出时名称会变为p1，参数b变为p2
  方法 输出(a : 整数, b: 文本)
    
  结束 方法
结束 类
```
### 生成创建
该属性会在类中自动生成静态的创建方法，并将类指定为禁止创建对象
### 强制依赖
该属性只能标注在类上，用于强制依赖输出某些类，即便这些类未被使用
示例：
```java
@强制依赖("AndroidX系列基础类")
类 学生
  
结束 类
```
### 单例类
该属性会在类中定义当前类的静态变量，并采用懒加载方式初始化静态实例，在类中会生成相应的获取实例方法，名称为”取实例“
### 输出到主包
该属性只能应用于类上，被标注的类在打包时将会被强制输出到主包，而非当前所处包
### 自定义组件
自定义组件，只能在目标平台为安卓平台的工程中使用，应用该属性后，将会在类中自动生成相关的初始嵌入式代码，无需再手动编写嵌入式代码
示例：
```java
@自定义组件("android.widget.TextView")
类 我的文本框 : 可视化组件
  
结束 类
```