Подскажите пожалуйста по код-стайлу. Я люблю комменты в функциях писать так,

Question

Подскажите пожалуйста по код-стайлу. Я люблю комменты в функциях писать так,

чтобы начало комментария во всех строках было с одного места, ну т.е. например:

reg <- function(y, x) {
x <- as.matrix(x) # переводим df в матрицу
x <- cbind(Intercept = 1, x) # добавляем столбец для $beta_0$
b <- solve(t(x) %*% x) %*% t(x) %*% y # считаем вектор $beta$
colnames(b) <- "estimate"
print(b)
}

Каждый раз, чтобы получить такое, отбиваю от каждой строки нужное количество пробелов до начала коммента. Есть ли какой-то более «правильный» способ подобного комментирования? Может быть какое-то сочетание клавиш или (внезапно) какое-то окно редактирование функции?
Или это чисто моя заморочка, поэтому унифицированных решений нет?

#programming #r #russian

0

10.05.2021

3 ответов

24 просмотра

Stas Автор вопроса

Andrey
я пишу каменты в одну строку с кодом только в случ...

Не так часто шэрю свой код, да и код-ревью у нас в компании делать не кому. В стайл-гайдах к тому же tidyverse, не нашёл особых указаний на этот счёт, поэтому комменчу так, как когда-то научился в APL (там как раз было окно редактирования функции). Если всё же лучшей практикой является комментирование строки до выражения, будем-с переучиваться.

0

10.05.2021

Andrey

Stas
Не так часто шэрю свой код, да и код-ревью у нас в...

http://adv-r.had.co.nz/Style.html

0

10.05.2021

Andrey · Accepted Answer

Andrey

я пишу каменты в одну строку с кодом только в случае пояснения параметров функции (когда не пишу нормальную документацию). А так лучше в отдельной строке.

0

10.05.2021

169 похожих чатов

Подскажите пожалуйста по код-стайлу. Я люблю комменты в функциях писать так,

3 ответов

Похожие вопросы