Документирование кода в Engee
Автор
println("Greeting from TemperatureScales.jl!")
const variable_from_TemperatureScales::Int64 = 3
"""
Модуль перевода температур. Поддерживает шкалы:
- Фаренгейта
- Цельсия
## Основные функции:
`fahr2cels`, `cels2fahr`,
"""
module TemperatureScales
export fahr2cels, cels2fahr, ScaleInfo
"Коэффициент преобразования из шкалы Фаренгейта в шкалу Цельсия или обратно"
K_CF, K_FC, S_CF, S_FC
K_CF = 9 / 5
K_FC = 5 / 9
S_CF = 32
S_FC = -32
@doc raw"""
fahr2cels(t_f::Real)
Преобразует число t_f из шкалы Фаренгейта в шкалу Цельсия по формуле
```math
\frac{5}{9}(t_f+32)
```
"""
function fahr2cels(t_f::Real)
return K_FC * (t_f + S_FC)
end
@doc raw"""
fahr2cels(t_f::String)
Сначала преобразует строку в число, затем конвертирует.
# Extended help
Здесь мы можем указать более подробную документацию
"""
function fahr2cels(t_f::String)
t_f = parse(Float64, t_f)
return K_FC * (t_f + S_FC)
end
"""
cels2fahr(t_c)
Преобразует температур в градусах Цельсия в градусы Фаренгейта по формуле
``\\frac{9}{5}(t_c - 32)``
"""
function cels2fahr(t_c::Real)
return K_CF * (t_c + S_CF)
end
"""
Справка о создании шкалы:
- `author_name` - Имя создателя
- `year` - год изобретения
- `symbol` - обозначение градуса
"""
struct ScaleInfo
author_name::String
year::UInt16
symbol::Char
end
end;