Typescript: Существуют ли какие-либо соглашения по документированию кода с комментариями?C#

Место общения программистов C#
Ответить
Anonymous
 Typescript: Существуют ли какие-либо соглашения по документированию кода с комментариями?

Сообщение Anonymous »

Я привык документировать код в наших проектах C# особым образом, чтобы повысить производительность команды, получить преимущества от Intellisense в Visual Studio и т. д.

Код выглядит примерно так :

Код: Выделить всё

/// 
/// Loads a user with a specific id.
/// 
/// 
The id of the user to search for.
/// A user with the given id.
public User GetUserById(string id) {
...
}
Существуют ли какие-либо аналогичные соглашения для Typescript для комментариев и документации? Или даже инструменты, которые используют эти соглашения для создания страниц документации в формате HTML из комментариев к коду (например, JavaDoc)?


Подробнее здесь: https://stackoverflow.com/questions/429 ... h-comments
Ответить

Быстрый ответ

Изменение регистра текста: 
Смайлики
:) :( :oops: :roll: :wink: :muza: :clever: :sorry: :angel: :read: *x)
Ещё смайлики…
   
К этому ответу прикреплено по крайней мере одно вложение.

Если вы не хотите добавлять вложения, оставьте поля пустыми.

Максимально разрешённый размер вложения: 15 МБ.

Вернуться в «C#»