matiko101 Temat założony przez niniejszego użytkownika |
Poprawne formatowanie kodu » 2013-12-29 18:55:43 Witam,
Od dłuższego czasu nurtuje mnie pytanie jak powinno się formatować kod.
Są jakieś "standardy" ?
Jak pisać, aby innym programista mógł się poczuć w kodzie jak u siebie w domu ?
Aktualnie staram się pisać:
- nazwy zmiennych odzwierciadlające ich rolę
- więcej zmiennych/funkcji, ale do konkretnego celu
- staram się skracać nazwy zmiennych/funkcji tak aby inny programista wiedziało po co ona jest, ale i żeby składała się z 2 krótkich wyrazów.
- "zmienne tablicowe" zaczynające się na tab_
- funkcje "podobnej" funkcji w kodzie zaczynające się podobną nazwą np. losowanie_liczb. losowanie_znakow
Tylko mi przyszło do głowy co aktualnie staram się stosować.
Tylko nie wiem jak poprawnie formatować kod ? Proszę o jak najwięcej wskazówek.
Nie mogę wkleić mojego kodu, bo z tego co widziałem strona sama sobie formatuje, a nawet jeśli nie to wklejając zmienia mi się ułożenia wszystkich linii.
|
|
pekfos |
» 2013-12-29 19:02:48 |
|
kubawal |
» 2013-12-30 11:29:52 - nazwy zmiennych odzwierciadlające ich rolę
- więcej zmiennych/funkcji, ale do konkretnego celu
- staram się skracać nazwy zmiennych/funkcji tak aby inny programista wiedziało po co ona jest, ale i żeby składała się z 2 krótkich wyrazów.
- "zmienne tablicowe" zaczynające się na tab_
- funkcje "podobnej" funkcji w kodzie zaczynające się podobną nazwą np. losowanie_liczb. losowanie_znakow |
To wszystko nie ma za wiele wspólnego z formatowaniem kodu. 1. Wszystkie nazwy pisz po angielsku, chyba, że kompletnie togo języka nie ogarniasz. Identyfikatory bez polskich znaków, np. zazolc_gesia_jazn nie wyglądają zbyt pięknie. 2. Jeśli korzystasz w programie z jakiejś biblioteki, to możesz dostosować się do zasad nazewnictwa i formatowania w niej. Możesz sobie tak że poczytać: http://www.sourceformat.com/coding-standard.htmhttp://technojazda.wikidot.com/standardcpp Ja stosuje obecnie taką konwencję: #include "PlayerPsychics.h"
#define MACRO
class Player
{
public:
Player( int i, int j );
Player( int i, int j, int y );
void setPosition();
bool isMoving;
};
namespace platformer
{
}
enum class Direction
{
Left,
Right
};
|
|
matiko101 Temat założony przez niniejszego użytkownika |
» 2013-12-30 11:40:58 Napisałem, że nie wiem jak powinno się formatować kod, a potem jak powinno się pisać poprawnie kod.
Pekfos czytałem Wikipedię, ale według mnie kod podany w 1. przykładzie jest mało czytelny, a w poniżej wymienionych "stylach" formatowania kodu jestem zielony i nie mam pojęcia jak je wykorzystywać.
Prosiłem o wskazówki właśnie związane z tymi myślnikami, które "nie są związane z tematem" i formatowaniem kodu.
EDIT: dzięki kubawal |
|
pekfos |
» 2013-12-30 12:17:24 | wyliczenia, jeśli są w zasięgu globalnym, muszą być zdefiniowane jako enum class |
Od kiedy? |
|
kubawal |
» 2013-12-30 12:18:03 W moim kodzie od zawsze :) |
|
DejaVu |
» 2013-12-30 12:36:23 |
|
pekfos |
» 2013-12-30 12:44:26 | W moim kodzie od zawsze :) |
To się nie wlicza do formatowania kodu. Po prostu struktura języka, której czasem wypada użyć, ale nie ma żadnego przymusu. Nie pisz, w takich przypadkach, że coś musi być zrobione w określony sposób, bo to po prostu nie jest prawda. |
|
| « 1 » |