PL:Styl programowania

From PsiWiki

Poniżej jest spisanych kilka uwag odnośnie stylu programowania (kodowania?), które należy wziąść pod uwagę podczas tworzenia łatek. Ze względów historycznych, możesz znaleźć fragmenty kodu w samej Psi, które nie są zgodne z poniższymi regułami. Mamy nadzieję, że kolejne wersje Psi będą miały kod źródłowy coraz bardziej zgodny z poniższymi regułami.

• Do wcięć używaj tabów, a nie spacji.
• Używaj foreach do iterowania po kolekcjach.
• Do wysyłania sygnałów, używaj emit foo(); zamiast foo();.
• Używaj

#include <QClass>

zamiast

#include <qclass.h>

• Staraj się umieszczać klasy w odrębnych plikach (podobnie jak w Javie).
• Dokumentuj każdą metodę i klasę w plikach .cpp używając DoxyGen. Zajrzyj do growlnotifier.cpp jeśli chcesz zobaczyć przykład jak to robić.
• Zawsze używaj klamr do tworzenia bloków kodu, nawet jeśli dany blok kodu zawierać będzie jedną linię, tzn.

if (condition) {
  doSomething();
}

a nie

if (condition)
  doSomething();

• Klamry otwierające blok kodu powinny być umieszczane w tej samej linii, tzn.

int getInt() {

a nie

int getInt()
{

• Klamry zamykające blok kodu powinny być umieszczane w oddzielnej linii, wyrównany w pionie z instrukcją otwierającą dany blok kodu. Szczególnymi dwoma przypadkami klamr zamykających blok kodu są:

} else {

oraz

do {
  // ...
} while (...);

Generalnie - staraj się dostosować do kodu, który łatasz. ;)