| про документацию в исходниках |
[Jul. 11th, 2017|07:15 am] |
вот такое, как ниже — это пишут только дебилы, студенты (они обычно тоже дебилы) и те, кому иначе зарплату срезают:
/// <summary>
/// Do something with lists.
/// </summary>
/// <typeparam name="T">List type</typeparam>
/// <param name="a">First list</param>
/// <param name="b">Second List</param>
/// <returns>Some shit.</returns>
static bool Foo<T>(LinkedList<T> a, LinkedList<T> b)
и нет, я не про пояснения, которые от балды, я про уёбищное, бесполезное многословие. а в дишечке это будет вот так:
/** Do something with lists.
*
* Params:
* T = list type
* a = first list
* b = second list
*
* Returns:
* Some shit.
*/
ёба, такую хуйню даже я иногда пишу, потому что она читабельна глазами — в отличие от первой нахуй бесполезной ебанины. потому что если ваша документация живёт в каментах, и при этом нихера не читается глазами — то она бесполезна. совершенно.
p.s.: если кому не ясно: в дишечке извлекать такие комментарии и делать из них всякий там html умеет прямо компилятор, внешние тулзы не обязательны. |
|
|