1
1
# Тестове в документацията
2
2
3
3
Главният начин да се документира проект в Ръждьо е чрез добавяне на бележки в
4
- изходния код. Документалните коментари се пишат според [ Спецификацията на
4
+ изходния код. Документните коментари се пишат според [ Спецификацията на
5
5
CommonMark Markdown] [ commonmark ] и поддържат блокове от код в тях. Ръждьо се
6
- грижи за правилността, така че тези блокове от код се компилират и ползват като
6
+ грижи за правилността, така че тези блокове от код се компилират и се ползват като
7
7
тестове от документацията.
8
8
9
9
``` rust,ignore
@@ -21,7 +21,7 @@ pub fn add(a: i32, b: i32) -> i32 {
21
21
a + b
22
22
}
23
23
24
- /// Обикновено документалните коментари може да включват раздели „Examples”,
24
+ /// Обикновено документните коментари може да включват раздели „Examples”,
25
25
/// „Panics” и „Failures”.
26
26
///
27
27
/// Следващата функция дели едно число на друго.
@@ -50,7 +50,7 @@ pub fn div(a: i32, b: i32) -> i32 {
50
50
}
51
51
```
52
52
53
- Блоковете код в документацията биват тествани автоматично, щом изпълните
53
+ Блоковете код в документацията биват тествани автоматично, щом пуснете
54
54
командата ` cargo test ` :
55
55
56
56
``` shell
@@ -71,20 +71,20 @@ test result: ok. 3 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out
71
71
72
72
## Основания за тестове в документацията
73
73
74
- Главната цел на документалните тестове е да служат като примери, които ползват
75
- предоставяната функционалност, а това е най-важното
76
- [ ръководство ] [ question-instead-of-unwrap ] . То ни позволява да ползваме примерите
74
+ Главната цел на документните тестове е да служат като примери, които ползват
75
+ предоставяната функционалност, а това са най-важните
76
+ [ насоки ] [ question-instead-of-unwrap ] . Те ни позволяват да ползваме примерите
77
77
от документацията като пълноценни парчета код. Но ползването на ` ? ` прави така,
78
78
че компилацията се проваля, понеже ` main ` връща ` unit ` . В този случай можем да
79
- скрием няколко реда код от документацията: Можем да напишем `fn try_main() ->
79
+ скрием няколко реда код от документацията: можем да напишем `fn try_main() ->
80
80
Result<(), ErrorType>` , да я скрием и разгърнем ( ` unwrap` ) в скритата ` main`.
81
81
Сложно ли звучи? Ето пример:
82
82
83
83
``` rust,ignore
84
- /// Използване на скрита `try_main` в документални тестове.
84
+ /// Използване на скрита `try_main` в документни тестове.
85
85
///
86
86
/// ```
87
- /// # // Скритите редове започват със знака `#` но са също компилируеми!
87
+ /// # // Скритите редове започват със знака `#`, но са също компилируеми!
88
88
/// # // Ред, който обгръща тялото, показано в документацията.
89
89
/// # fn try_main() -> Result<(), String> {
90
90
/// let res = doccomments::try_div(10, 2)?;
@@ -108,7 +108,7 @@ pub fn try_div(a: i32, b: i32) -> Result<i32, String> {
108
108
## See Also
109
109
110
110
* [ RFC505] [ RFC505 ] за стила на документацията;
111
- * [ API Guidelines] [ doc-nursery ] За насоки при документиране.
111
+ * [ API Guidelines] [ doc-nursery ] за насоки при документиране.
112
112
113
113
[ doc-nursery ] : https://rust-lang-nursery.github.io/api-guidelines/documentation.html
114
114
[ commonmark ] : https://commonmark.org/
0 commit comments