Added annotation documentation

This commit is contained in:
huangzhhui 2019-03-20 11:50:05 +08:00
parent 5992cad6ae
commit 6946dc7832
2 changed files with 35 additions and 0 deletions

22
zh/annotation/intro.md Normal file
View File

@ -0,0 +1,22 @@
# 概念
## 什么是注解什么是注释?
在解释注解之前我们需要先定义一下 `注解``注释` 的区别:
- 注释:给程序员看,帮助理解代码,对代码起到解释、说明的作用。
- 注解:给应用程序看,用于元数据的定义,单独使用时没有任何作用,需配合应用程序对其元数据进行利用才有作用。
## 注解解析如何实现?
Hyperf 使用了 [doctrine/annotations](https://github.com/doctrine/annotations) 包来对代码内的注解进行解析,注解必须写在下面示例的标准注释块才能被正确解析,其它格式均不能被正确解析。
注释块示例:
```php
/**
*
*/
```
在标准注释块内通过书写 `@AnnotationClass()` 这样的语法即表明对当前注释块所在位置的对象(类、类方法、类属性)进行了注解的定义, `AnnotationClass` 对应的是一个 `注解类` 的类名,可写全类的命名空间,亦可只写类名,但需要在当前类 `use` 该注解类以确保能够根据命名空间找到正确的注解类。
## 注解是如何发挥作用的?
我们有说到注解只是元数据的定义,需配合应用程序才能发挥作用,在 Hyperf 里,注解内的数据会被收集到 `Hyperf\Di\Annotation\AnnotationCollector` 类供应用程序使用,当然根据您的实际情况,也可以收集到您自定义的类去,随后在这些注解本身希望发挥作用的地方对已收集的注解元数据进行读取和利用,以达到期望的功能实现。

13
zh/annotation/usage.md Normal file
View File

@ -0,0 +1,13 @@
# 使用注解
## 使用类注解
## 使用类方法注解
## 使用属性注解
# 自定义注解
## 定义一个自定义注解
### 自定义注解收集器