Поле должно иметь заголовок документации - Полицейского Стиля - запах Кода?
Просто используйте Transpose:
m=df.transpose()
А затем:
[str(list(a)[0])+'|'+str(list(a)[1]) for a in m.values]
5 ответов
Я бы не сказал, что комментирование переменной - это всегда запах кода (и это тоже не похоже на то, что вы говорите). Я согласен, что комментирование каждой переменной, каждый раз является как минимум чрезмерным и, возможно, указывает на плохое именование. Фактически, некоторые утверждают, что любой комментарий является запахом кода, и что описательные имена и короткие подпрограммы более читабельны и предотвращают ситуацию, когда код был изменен, но комментарии не были обновлены (что конечно, укусил меня в несколько унаследованных кодовых баз). Я не думаю, что я зайду так далеко, но если вы можете написать код, который говорит само за себя без дополнительного объяснения, это кажется предпочтительным.
Так что да, в основном то, что вы сказали.
Я думаю, что правильный ответ здесь - «это зависит от обстоятельств». Вы, конечно, можете объяснить «почему» переменной, помеченной как статическая / константная, или бизнес-логику / ограничения на содержимое переменной. Сказав это, я согласен с тем, что просмотр каждого комментария к переменной затрудняет читаемость и может слепо указывать на стандартное или неправильное именование.
Комментарии XML немного отличается от других комментариев.
Если вы все настроили правильно, вы можете сделать так, чтобы они отображались во всплывающих подсказках в Visual Studio И использовали их для создания документации в стиле MSDN с Sand Castle. Я думаю, они должны рассказать вам, что делает эта штука, когда у вас нет доступа к исходному коду.
Дело в том, что эти комментарии могут появляться без исходного кода, который они комментируют. Они должны быть полезны другому разработчику, который не видит ваш код и не заботится о том, как вы что-то делаете.
Я не знаю об инструменте "Cop", который вы используете, но было бы неплохо иметь способ обозначить инструмент, который намеревается оставить параметр пустым. Итак:
/// <param name="fubar"></param> // Haven't gotten around to it
/// <param name="portNumber" /> // I intend this parameter to have no help
Я работал над проектами, в которых мы должны все заполнить, и мы получили такие вещи, как:
/// <param name="portNumber">The Port Number</param> // What else could it be?
Если вы не хотите использовать указанные выше функции, отключите правило Style Cop.
но было бы неплохо иметь способ сигнализировать инструменту, который намеревается оставить параметр пустым. Итак: /// <param name="fubar"></param> // Haven't gotten around to it
/// <param name="portNumber" /> // I intend this parameter to have no help
Я работал над проектами, в которых мы должны все заполнить, и мы получили такие вещи, как:
/// <param name="portNumber">The Port Number</param> // What else could it be?
Если вы не хотите использовать указанные выше функции, отключите правило Style Cop.
но было бы неплохо иметь способ сигнализировать инструменту, который намеревается оставить параметр пустым. Итак: /// <param name="fubar"></param> // Haven't gotten around to it
/// <param name="portNumber" /> // I intend this parameter to have no help
Я работал над проектами, в которых мы должны все заполнить, и мы получили такие вещи, как:
/// <param name="portNumber">The Port Number</param> // What else could it be?
Если вы не хотите использовать указанные выше функции, отключите правило Style Cop.
Полностью согласен и первое, что я отключил в StyleCop. Если вам нужно объяснить это, вы назвали его способом, требующим объяснения, и не смогли сделать код самодокументированным .
Вы должны попробовать GOSDOC - это простой способ получить документацию, автоматизированную для каждого члена кода в вашем приложении. Просто установите его, щелкните правой кнопкой мыши на участнике и выберите «Документ»!