2009-08-07 12 views
5

Czasami, aby nazwa zmiennej/metody/klasy była opisowa, muszę ją wydłużyć. Ale nie chcę, chciałbym mieć krótkie nazwy, które są łatwe do odczytania. Pomyślałem więc o specjalnym dodatku do IDE, takim jak Visual Studio, aby móc pisać krótkie nazwy dla klasy, metody, pola, ale móc dołączyć długie nazwy. Jeśli musisz - możesz zrobić wszystko długo lub możesz zrobić jedną nazwę długo. Jeśli chcesz go zmniejszyć - użyj redukcji, jak dwa widoki tego samego kodu. Chciałbym wiedzieć, co myślą o tym inni? Czy uważasz, że jest to przydatne? Czy ktokolwiek użyłby tego rodzaju dodatku?Redukcje w programowaniu

+0

Dzięki za wszystkie odpowiedzi. Pewnie, gdy wybieram mult i multiply, wolę mnożyć, ale jest za to *. Po prostu wyobraź sobie rozmnażanie zamiast *. Każda formuła matematyczna byłaby koszmarem. Mówię o przypadkach, w których wybór pomiędzy długą i opisową nazwą, a krótką i łatwą w użyciu nie jest oczywisty. Na przykład. jakaś dziedzina jak finanse. Jeśli nie znasz domeny, potrzebujesz długich nazw, jeśli wiesz - możesz użyć skrótu. Nie chcę też, żeby to było jak sama nazwa, myślę o tym jak o innym widoku. Podobnie jak w przypadku widoku UML dla klas w VS, takich jak eksplorator obiektów i Eksplorator rozwiązań. –

Odpowiedz

6

nigdy martwić o długich nazwach. Jeśli nazwa metody staje się zbyt długa, może również wskazywać, że metoda jest zbyt duża (chyba, że ​​zawiera naprawdę długie słowo). Z drugiej strony staram się również unikać powtarzania siebie. Na przykład nie miałbym Account.AccountId, ale raczej Account.Id. Opieram się także na przestrzeni nazw; jeśli przestrzeń nazw jest jasna co do domeny, w której się znajduję, zazwyczaj staram się nie powtarzać tego w nazwach klas lub członków.

Dolna linia; Nie widzę siebie, używając takiego dodatku.

8

Nazwa zmiennej powinna być tak długa, aby była możliwa do zidentyfikowania, czy ma to znaczenie, czy jest ona nieco dłuższa niż wolisz? Dopóki kod jest czytelny i zrozumiały, z pewnością nie ma to znaczenia?

Używaj komentarzy dla nazw, które byłyby zbyt długie w użyciu jako nazwa zmiennej/klasy. Byłoby to o wiele bardziej odpowiednie.

Jeśli nazwa metoda jest zbyt długi, to nie powinno być pojedyncza metoda ...

nie będę używać Addin tak.

4

Inni programiści bez tego dodatku wpadliby w kłopoty, ponieważ jeśli podasz zbyt krótkie imiona, nie zrozumieją w pełni kodu, jeśli podasz długie imiona, stracą czas na czytanie i w końcu wpadają w złość, ponieważ długie nazwy są trudne do zapamiętania : P

Należy znaleźć najlepszą nazwę dla wszystkiego, co pisze, gdy nie ma potrzeby, aby przełącznik włączał i wyłączał gadatliwość dla identyfikatorów.

Nie użyłbym tego dodatku.

0

Nie sądzę, że bym tego chciał.

Narzut przełączania między różnymi widokami byłby tyle pracy, co naciśnięcie klawisza F12 i przeczytanie komentarza do funkcji, która zawsze będzie bardziej opisowa niż długa nazwa.

9

Dlaczego po prostu nie używać standardowego systemu komentowania XML wbudowanego w Visual Studio. Jeśli wpiszesz /// powyżej klasy/metody/zmiennej itp., Utworzy to skrót komentarza. Te komentarze wyskakują przez Intelisense/Code Completion z dodatkowymi informacjami.

W ten sposób zachowujesz krótką i opisową konwencję nazewnictwa, jednocześnie komentując swój kod. Można uruchomić proces, aby następnie utworzyć dokumentację kodu za pomocą tych komentarzy.

Patrz: http://msdn.microsoft.com/en-us/magazine/cc302121.aspx

+1

lub "" w vb.net – Pondidum

0

Nie będę.

Długie nazwy funkcji mogą być przydatne w niektórych przypadkach. Jeśli masz specjalny przypadek lub coś takiego. Kilka przykładów:

co byś faworyzował do mnożenia, mul lub mnożenia? pomnożyć to mój wybór

Wybór functionnames to kwestia dokonywania kod jasne za korzystanie, jeśli masz zbyt małe nazwy i trzeba czytać komentarz wiedzieć, co robi funkcja, a następnie youre robi to źle

1

Nor I. Faktem jest, że mówisz o VisualStudio. Potrzeba dużego zapamiętania większości nazw zmiennych (długich i krótkich) za pomocą technologii IntelliSense. Jak powiedziała Power, tak długo, jak kod jest czytelny i zrozumiały, liczy się tylko to.

0

IDE, edytory tekstu i kompilatory obsługują ograniczoną (jeśli w ogóle ograniczoną) formę opisywanej funkcjonalności - czyli komentarze kodu źródłowego. Myślę, że komentarze robią bardzo dobrze i nie widzą potrzeby opisywanego dodatku. Jeśli komentarze są za długie, można je złożyć. Jeśli potrzebujesz kodu źródłowego bez komentarzy, możesz łatwo usunąć je za pomocą regex podobnych rzeczy.

0

Chciałbym mieć krótkie nazwy, które są łatwe do odczytania pod .

To często sprzeczność w terminach.

Weźmy na przykład nazwę taką jak oScBf, jeśli jeszcze nie wiesz, co to jest praktycznie niemożliwe do odczytania. Czy to outputScreenBuffer, onlineSourceBitflag, openScannerBrowsefile, outdoorSpecialBikinifavorites ...?

Dłuższe nazwy identyfikatorów są zwykle preferowane. Mimo że jest to bardziej czytelne, to jest jeszcze łatwiejsze do zrozumienia.

Czytanie kodu jest w pewien sposób podobne do czytania tekstu. Oczekuje się, że podążanie za określonym wzorem będzie łatwe do odczytania, jeśli zaczniesz dodawać wiele skrótów. i niestosowne słowa w tekście u hav 2 przestańcie myśleć, co to znaczy, i tracicie przepływ. :)

+0

Zgadzam się z Tobą. Ale to jest, jeśli masz tylko jedną rzecz, którą musisz zmniejszyć. Zawsze lepiej napisać pełną nazwę i wszystko staje się jasne dla czytelnika. Ale co jeśli masz skomplikowaną logikę, w której nie wiesz jak nazwać zmienne, aby twój przyszły czytelnik zrozumiał, co się dzieje? Długie nazwy dobrze wyjaśniają wszystko, ale po tym, co niektóre zmienne chcesz zmniejszyć i przeczytać o innych. jeśli jest 10 elementów, które o nich przeczytasz i będą musiały zostać zredukowane, aby dostać się do samego algorytmu. –

-2

Podoba mi się ten pomysł. Jest naprawdę dobry i gratuluję ci i mam nadzieję, że uda Ci się go rozwinąć. Chociaż nigdy nie używałbym takiego dodatku.

+0

Zabawny sposób na powiedzenie, że naprawdę tego nie lubisz – raven

+0

Właściwie to podoba mi się ten pomysł. Powodem, dla którego nie użyłbym tego, jest to, że przyzwyczaiłem się do pisania rzeczy w określony sposób, i gdybym zaczął z nich korzystać - ciągle zapominałem i piszę to, co zwykle piszę ... Pomysł jest świetny. Myślę, że zaoszczędzi to mnóstwo czasu i ułatwi zapamiętywanie rzeczy. Ale to po prostu nie dla mnie. Z pewnością nie sądzę, że moja osobista opinia ostrzega, że ​​2 głosy sprzeciwiają się ... –

0

To zły pomysł. Nazwy zmiennych zwykle nie muszą być długie, aby były odpowiednio opisowe, tracisz dużo czasu na pisanie dwóch wersji każdego nazwiska, a wielu programistów prawdopodobnie uzna to za mylące, ponieważ ma wiele nazw dla tego samego.

Dzięki pomocy XMLDoc i intellisense można dodać wszelkie dodatkowe szczegóły wymagane do pełnego opisania elementu kodu - nazwa nie musi opisywać drobnych szczegółów, daje jedynie wyraźne i wyraźne wyobrażenie o tym, jaki jest cel elementu kodu.

Łatwo dostępne automatyczne uzupełnianie nazw, nie ma już powodów do narzekania na długie nazwy wymagające dużej ilości pisania.

Również dobry styl kodowania polega na tym, aby kod był łatwy do odczytania, zrozumienia i konserwacji, a nie do pakowania większej ilości kodu na mniejszą przestrzeń.

OO projekt powinien pomóc przełamać funkcjonalność dół hierarchicznie w przestrzeni nazw i klas, zmniejszając potrzebę takich długich nazw w klasie/poziom metoda)

Wreszcie, jeśli naprawdę musi skrócić nazwy, większość języki większość języków świadczenia proste sposoby na pozbycie się przestrzeni nazw i/lub dodanie całkiem nowych aliasów dla nazw (np"typedef" i "using" w C++, "używając" w języku C#), więc w zlokalizowanym regionie możesz łatwo odnieść się do długiej nazwy poprzez skrócony wariant lub alias, jeśli chcesz.

Powiązane problemy