Если у меня есть фрагмент кода, который математически или структурно довольно сложен и неуменьшаем, так, как бы я занялся документированием этого фрагмента кода? В частности, как я могу гарантировать, что кто-то, кто не обладает математическими или архитектурными навыками, сможет понять это из...
Я (случайно) исследовал основанные на семантике / онтологии подходы к технической документации, когда наткнулся на этот драгоценный камень : Грамотное программирование и семантическая паутина - это идеи разных времен, у которых есть связь. Связанная статья, Нормальное программирование в XML Нормана...
Во-первых, я понимаю, что этот вопрос может быть несколько длинным и расплывчатым, и я прошу прощения за это. Вероятно, это основная проблема с коротким именем для любого, кто "получил его", но, поскольку мне не хватает в этом отношении, пожалуйста, потерпите меня при описании проблемы. Так или...
Мне интересно посмотреть, как другие люди делают это. Особенно в ситуациях, когда несколько разных клиентов используют одну и ту же программную базу с немного разными бизнес-правилами. Какие методы вы используете, чтобы документировать, как все должно работать или бизнес-правила. По сути, когда в...
Я собираюсь покинуть проект, и прежде чем я уйду, мой начальник попросил меня документировать код (я не очень хорошо задокументировал). Это не имеет большого значения, проект не очень сложный. Но я нахожу в своей документации места, где я хотел бы сказать: «В строке XYZ обратите внимание, что...
Это относится к обсуждению в ответе и комментариям к этому вопросу: что происходит с отвращением к документации в отрасли? , В ответе утверждалось, что «код не может лгать» и, следовательно, должен быть местом для перехода, а не документацией. В нескольких комментариях указывалось, что «код может...
Рассматривая реализацию функции другого программиста для вычисления CDF нормального распределения , я предложил либо заменить всю реализацию встроенными функциями Python, либо использовать SciPy, общую научную библиотеку. Другой программист отметил, что ни math.erfc()не scipy.stats.norm.cdf()дает...
Я работаю над небольшой библиотекой, которая обеспечивает реализацию основных, хорошо известных строковых метрик. Главным образом для моего собственного образования. Так что развитие происходит всякий раз, когда у меня есть немного свободного времени. Из-за этого я автоматизировал большинство...
Часто я решаю ошибки, находя ответ по переполнению стека. Это плохая практика - добавлять фрагмент того, почему я сделал то, что я сделал, а затем добавить ссылку на статью или страницу из...