Передовой опыт в написании кода MATLAB? [закрыто]

Лучший совет, который я получил, задав этот вопрос, был следующим:

Never code while drunk.

Вы можете ознакомиться с онлайн-курсом Стэнфорда: Методология программирования CS106A. Инструктор дал несколько действительно хороших инструкций по написанию исходного кода.

Вот некоторые из них:

1. писать программы для чтения людьми, а не только для компьютеров. Они оба должны уметь его читать, но гораздо важнее, чтобы человек прочитал и понял его, и чтобы компьютер все равно правильно его выполнил. Но это первый основной принцип разработки программного обеспечения, думать о.

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

3. Как сделать декомпозицию

   1. Один метод решает одну проблему
   2. Каждый метод имеет код примерно 1~15 строк
   3. Дайте методам хорошие имена
   4. Напишите комментарий к коду

Посмотрите 97 ​​вещей, которые должен знать каждый программист.
Это бесплатно и содержит много жемчужин, таких как эта:

Есть одна цитата, которая, я думаю, особенно хорош для всех программ разработчики должны знать и держать рядом с собой их сердца:

Красота стиля, гармония и изящество а хороший ритм зависит от простоты. — Платон

В одном предложении, я думаю, это резюмирует ценности, которые мы как программное обеспечение разработчики должны стремиться.

Есть ряд вещей, к которым мы стремимся ибо в нашем коде:

• Удобочитаемость
• Сопровождаемость
• Скорость разработки
• Неуловимое качество красоты

Платон говорит нам, что возможность фактором всех этих качеств является простота.

Европейские стандарты написания и документирования сменного кода Fortran 90 были в моих закладках, как всегда. Кроме того, здесь была тема, поскольку вы интересуетесь MATLAB, по организации кода MATLAB .

Если вы хотите использовать что-то в качестве справочника или этикета, я часто следую официальным соглашениям о стиле Google для любого языка, с которым я работаю, например, для C++ или для Python.

В «Практике программирования» Роба Пайка и Брайана У. Кернигана также есть раздел о стиле, который я нашел полезным.

Прочитайте Code Complete, он сотворит чудеса для всего. Он покажет вам, где, как и когда что-то имеет значение. Это практически Библия разработки программного обеспечения (ИМХО).

Руководство по стилю программирования MATLAB Ричарда Джонсона — хороший ресурс.

Руководство по стилю Python всегда является хорошей отправной точкой!

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

Здесь почти все сказано, и даже больше. На мой взгляд, лучший сайт о том, что вы ищете (особенно дзен частей python — это весело и правда)

http://python.net/~goodger/projects/pycon/2007/idiomatic/handout.html

Разговоры как о PEP-20, так и о PEP-8, о некоторых пасхальных яйцах (забавные вещи) и т. д.

Выше было сделано много хороших замечаний. Я определенно поддерживаю все вышеперечисленное. Я также хотел бы добавить, что орфография и последовательность в кодировании должны быть тем, что вы практикуете (и также в реальной жизни).

Я работал с несколькими оффшорными командами, и хотя их английский довольно хорош, их орфографические ошибки вызывали много путаницы. Так, например, если вам нужно найти какую-то функцию (например, getFeedsFromDatabase), а они неправильно пишут базу данных или что-то еще, это может быть большой или маленькой головной болью, в зависимости от того, сколько у вас зависимостей от этой конкретной функции. Тот факт, что это повторяется снова и снова в коде, во-первых, сведет вас с ума, а во-вторых, затруднит синтаксический анализ.

Кроме того, соблюдайте последовательность в именовании переменных и функций. Есть много протоколов, которым нужно следовать, но пока вы последовательны в том, что делаете, другие, с которыми вы работаете, смогут лучше читать ваш код и быть благодарными за него.