Przemyślenia powstałe podczas tworzenia programów w Clarionie.

piątek, 5 grudnia 2008

Standardy programowania - Atrybuty obiektów

Każdy przycisk paska narzędzi powinien mieć przyporządkowaną ikonę i ‘dymek’ podpowiedzi.
Spójność.

Każdy przycisk na formularzu powinien mieć ikonę oraz tekst.
Spójność.

Każde pole powinno mieć przypisany atrybut komunikatu.
Kreator tworzy ‘dymki’ automatycznie, jeśli opis pola jest w słowniku.

Każda zmienna przypisana do danego pola powinna mieć nazwę analogiczną do nazwy pola (np. ?pat:Fname)
Kod samodokumentujący się.

Nazwa każdej zmiennej przypisanej do opisu pola powinna składać się z nazwy pola, dwukropka i słowa PROMPT. (np. ?pat:Fname:Prompt)
Kod samodokumentujący się.

Nazwa każdej zmiennej przypisanej do opcji menu powinna składać się z przedrostka Mnu i nazwy wywoływanej procedury. (np. ?MnuBrwKlienci)
Kod samodokumentujący się.

Nazwa każdej zmiennej przypisanej do przycisku powinna składać się z przedrostka Btn i nazwy wywoływanej procedury (np. ?BtnBrwKlienci )
Kod samodokumentujący się.

Używaj checkboxów do opcji typu ‘Tak/Nie’. Do opisu używaj zdań twierdzących.
Spójność.

Używaj list rozwijanych typu combo-box zamiast przycisków opcji.
Spójność.
akurat ten punkt przydaloby sie przedyskutowac, co prawda chceboxy zajmuja wiecej miejsca ale program jest bardziej czytelny bo od razu widac co user ma wybrac - JK
Każdy przycisk ze skojarzonymi plikami potomnymi powinien zawierać szablon Child Files. (dostepny w klubowych szablonach)
Spójność.

Tekst etykiet (prompt) jest czarny, pisany z dużej litery i na takim samym tle jak okno.
Spójność.

Kolor czerwony (red) zarezerwowany jest dla celu podkreślenia w księgowości kwot (liczb) ujemnych.
Spójność.


Rozmiary

Wszystkie elementy okienka powinny używać ustawień danego okienka dla kroju, rozmiaru i stylu czcionki.
Spójność.

Wszystkie przyciski powinny mieć jednakowe rozmiary, domyślnie 48(szer.) X 16(wys.). Można użyć szerszych przycisków, gdy konieczne jest użycie dłuższego opisu.
Spójność.

Przyciski paska narzędzi powinny mieć jeden z dwóch rozmiarów: 24(s) X 22(w.) albo 32(s.) X 30(w.). Ikona przycisku powinna mieć rozmiary 16 X 16 lub 24 X 24.
Spójność.

Wszystkie pola tekstowe, spinboxy, i listy rozwijane powinny mieć ustawiony atrybut rozmiaru na ‘Default’. Ustawienie jest dostępne w sekcji ‘Position’ właściwości pola. Spowoduje to uzyskanie pól o wysokości 10 jednostek dla fontu 8-punktowego.
Spójność.

Wszystkie opisy pól powinny mieć ustawiony atrybut rozmiaru na ‘Default’. Ustawienie jest dostępne w sekcji ‘Position’ właściwości opisu. Spowoduje to uzyskanie opisów o wysokości 9 jednostek dla fontu 8-punktowego.
Spójność.
(te rozmiary na default warto sprawdzic, bo oryginalna dokumentacja byla pisana do MS San Serif, a teraz uzywamy Arial CE- JK
Przyciski VCR Buttons mają rozmiary 12 X 12.
Spójność.

Eliptyczne przyciski używane do wyszukiwania w bazie powinny mieć rozmiar 12W x 12H. Powinny mieć ikonę lookup’u i ‘dymek’ z opisem.
Spójność.


Rozmieszczenie

Wszystkie elementy okien dialogowych powinny być oddalone o 6 jednostek ( czyli dwa kroki siatki) od górnej bądź dolnej krawędzi okna. Wszystkie kontrolki powinny być również oddalone o 6 jednostek od spodu arkusza i od góry następnego pola. Pierwszy element na arkuszu powinien również być oddalony o 6 jedn. od spodu bądź góry arkusza.
Spójne, przejrzyste i wizualnie wyrównane okienka.

Wszystkie pola powinny być oddalone w pionie o 3 jedn. (1 krok siatki) i w poziomie o 6 jedn. (2 kroki siatki) od sąsiednich pól..
Spójne, przejrzyste i wizualnie wyrównane okienka.

Górna krawędź opisu pola powinna być umieszczona 3 jednostki (1 krok siatki) poniżej górnej krawędzi odpowiedniego pola. Opis powinien zawsze kończyć się dwukropkiem.
Spójne, przejrzyste i wizualnie wyrównane okienka.
To jest łatwe jak na promptach uzywa się rozmaru default, wtedy ich wysokośc jest mniejsza i ten punkt wtedy latwo wdrozyc – w wierszu rownac kontrolki i prompty w dół.
Wszystkie kontrolki powinny być wyrównane do lewej krawędzi okna. Przyciski stanowią wyjątek.
Spójne, przejrzyste i wizualnie wyrównane okienka.

Wszystkie kontrolki powinny być umieszczone w arkuszu właściwości formatera okienek, z wyjątkiem ogólnych przycisków, jak OK., Anuluj, Zamknij czy Pomoc, dotyczących całego okna.
Spójne, przejrzyste i wizualnie wyrównane okienka.

Nazwy ikon powinny być samoopisujące i spójne. (np., ok.ico dla ikony przycisku OK).
Spójność i łatwość zamiany ikon w całym systemie jednocześnie.
Nawet jeśli nie masz w danej chwiuli odpowiedniej ikony, wymysl dla niej nazwę taką wpisz w clarionie i skopiuj kontrolke cancel.ico pod tą nazwę. Wlasciwą ikonkę dobierzesz w przyszłości.
Wszystkie typowe przyciski powinny zawierać swoją własną ikonę. Ta opcja dostępna jest pod zakładką Extra na ekranie właściwości przycisku.
Spójność.

Wszystkie elementy okna powinny być umieszczone jeden pod drugim w pionie.
Spójność i łatwość odświeżania wyświetlanego ekranu.

Elementy powiązane ze sobą będą oddalone od siebie o 6 jednostki w poziomie i 3 jednostki w pionie (odp. 2 i 1 krok siatki). Elementy niepowiązane ze sobą będą oddalone od siebie o 9 jednostek w poziomie i 6 jedn. w pionie (odp. 3 i 2 kroki siatki).
Spójne, przejrzyste i wizualnie wyrównane okienka.

Jeśli na oknie występuje tylko jedna zakładka (General), to powinna być wyeliminowana. Jedynym wyjątkiem są okienka przeglądania danych, na których zakładka wskazuje sposób sortowania danych.
Spójne, przejrzyste i wizualnie wyrównane okienka. Uwaga: można to łatwo osiągnąć w kodzie źródłowym ekranu.

Przyciski powinny być umieszczone pod poziomo arkuszem, albo ułożone jeden nad drugim przy fragmentach, których dotyczą wykonywane przez nie akcje.
Spójne, przejrzyste i wizualnie wyrównane okienka

Przyciski poleceń odnoszące się bezpośrednio do wyświetlanych danych są zawsze umieszczane w dolnej części okna zaczynając od prawej strony przyciskiem 'Pomoc' lub w jego braku przyciskiem 'Zamknij'. Przyciski wywołujące tzw. potomków czyli okna zawierające dane podrzędne (podporządkowane) bieżącym umieszczane s± zawsze z lewej strony okna, zaczynając od góry.


Jeśli na danym ekranie znajdują się dwa lub więcej elementów typu lista (browse), to ich kolejność w zależności od hierarchii jest od góry do dołu i od lewej do prawej, a przyciski i opisy s± rozmieszczane wg wyżej wymienionych zasad w stosunku do właściwej dla nich listy (browse'a).

Brak komentarzy:

Współtwórcy