Documentation, some refactoring and new little feature #7
Conversation
AmsTaFFix
commented
Mar 18, 2015
AmsTaFFix
commented
- add documentation to classes;
- change names of arguments on more meaningful;
- add group_id parameter, when uploading photos in album,
- etc...
…field Add group_id because when you want to upload photo in group's album you have groupId in response of photos.getUploadServer, and have to set group_id when call photos.save method
… property to send photos.save request Because you have to set group_id when uploading photos in group's album
Because album_id/group_id is more meaningful than album/group
…method Because array ($files) will not be with numeric indexes every time
…:uploadAlbum() method Because listOfFilePaths is more meaningful then files. When you read new name, you can understand meaning of this arguments without reading documentation and fo not ask question "What files? Names? Paths? Resources? Maybe special objects?"
| { | ||
| if (sizeof($files) > 5 || sizeof($files) == 0) { | ||
| if (sizeof($listOfFilePaths) > 5 || sizeof($listOfFilePaths) == 0) { |
There was a problem hiding this comment.
Looks more complicated than it is. $files was good, just because phpDoc giving all necessary information.
There was a problem hiding this comment.
Как вы тут описали "phpDoc дает все необходимую информацию", но зачем читать этот phpDoc, когда само название переменной передает ВЕСЬ смысл содержимого в ней. И посмотрев на само название уже можно понять что туда передавать не тратя время на обращение к phpDoc'ам или чего хуже к реализации.
P.S. на данное изменение меня сподвигло маниакальное стремление к понятному коду, при чтении которого все становится ясно без обращения в посторонние источники.
P.P.S Если мои аргументы не произвели никакого действия, я изменю название обратно и впредь буду обсуждать изменения названий аргументов и переменных )
P.P.P.S. только что подошел коллега, который разбирался с кодом вместе со мной, так вот он мне напомнил, что он не понимал что передавать в параметр $files, пока не посмотрел на реализацию метода. И сказал, если бы было название listOfFilePaths или просто filePaths, не пришлось бы лезть в реализацию метода.
|
Seems pretty good, but look at comments that i had made upon commits |
