Пытанні з тэгам 'documentation'

ГЭТЫ тог ТОЛЬКІ ДЛЯ генератара ДАКУМЕНТА. Уключыце мова і / або тэг SDE. НЕ ВЫКАРЫСТОЎВАЙЦЕ, каб запытваць спасылкі на дакументацыю або прылады або крытыкаваць дакументацыю пастаўшчыка.
8
адказаў

Якая розніца паміж модульнымі, функцыянальнымі, прыёмнымі і інтэграцыйнымі тэстамі?

У чым розніца паміж тэставаннем на адзінку, функцыяналу, прыёмкі і інтэграцыі (і любыя іншыя тыпы тэстаў, пра якія я не згадваў)?
зададзены 05 февр. '11 у 2:59
8
адказаў

Які стандартны фармат docstring Python?

Я бачыў некалькі розных стыляў напісання docstrings ў Python, ці ёсць афіцыйны або "ўзгоднены" стыль?
зададзены 10 каст. '10 ў 4:10
11
адказаў

Прагляд інфармацыі аб метадзе ў Android Studio

У Eclipse, калі вы наводзіце паказальнік мышы на метад, з'явіцца акно з апісаннем таго, што робіць гэты метад, што азначаюць параметры і што ён вяртае. Ці ёсць спосаб прымусіць Android Studio зрабіць тое ж самае?
зададзены 18 мая '13 г у 3:49
4
адказаў

Ці ёсць у JavaScript стандарт для каментароў?

У цяперашні час я пішу код JavaScript на баку кліента і задаюся пытаннем, як каментаваць мае функцыі. Я зыходжу з фону З #, дзе ёсць афіцыйна рэкамендаваны стыль каментароў дакументаваны Microsoft, які я прытрымліваюся, што дазваляе да ...
зададзены 12 крас. '12 у 18:03
8
адказаў

Як напісаць добры README

Я думаю, што ўсе бачылі файл README, але я б хацеў, каб канчатковае кіраўніцтва аб тым, як напісаць выдатны файл README з найменшай колькасцю энергіі, выдаткаванай на яго. Што такое README файл? Што я павінен пісаць у ім? Як менавіта отф ...
зададзены 21 февр. '10 у 08:14
20
адказаў

Лепшыя парады па дакументаванні кода з выкарыстаннем doxygen?

Мая каманда пачынае дакументаваць наш C-код, выкарыстоўваючы doxygen, звяртаючы асаблівую ўвагу на нашы публічныя загалоўкі API. Здаецца, у doxygen шмат гнуткасці і розных спецыяльных каманд, што выдатна, але незразумела, якая добрая рэч і што дрэннае без про ...
зададзены 09 сент. '08 у 14:41
49
адказаў

Што такое самодокументирующий код і ці можа ён замяніць добра дакументаваны код?

У мяне ёсць калега, які настойвае на тым, што яго код не мае патрэбы ў каментарах, ён "сам дакументуе". Я прагледзеў яго код, і, хоць ён больш ясны, чым код, які я бачыў у іншых прадуктах, я па-ранейшаму не згодны з тым, што самодоку ...
зададзены 16 каст. '08 у 18:24
6
адказаў

Як напісаць дакумент тэхнічнай спецыфікацыі для майго праграмнага праекта?

Я бачыў тут некалькі пытанняў, якія будуць размаўляць, што няма неабходнасці пісаць шматспадзеўную тэхнічную спецыфікацыю, калі функцыянальная спецыфікацыя валодае ўсімі функцыянальнымі магчымасцямі. Што тычыцца сітуацый, калі кліент падаў электрарэлаксацыйны ...
зададзены 24 сакавіка '09 у 18:25
12
адказаў

Ці ёсць у Swift дакументы або інструменты для дакументацыі?

Шматлікія мовы падтрымліваюць каментары да дакументацыі, каб дазволіць генератара (напрыклад, javadoc або doxygen) генераваць дакументацыю кода шляхам аналізу той жа код. Ці ёсць у Swift якія-небудзь каментары да дакументацыі па дакументацыі або ін ...
зададзены 05 чэрвеня '14 у 0:34
16
адказаў

Добрае ўвядзенне ў .NET Reactive Framework

Акрамя дакументацыі Microsoft, ці ёсць добрае ўвядзенне і падручнік ў сераду Microsoft Reactive (Rx)? Акрамя таго, што з'яўляецца добрым прыкладам (з кодам), што Reactive спрашчае задачу праграмавання, якую складана вырашыць з выкарыстаннем звычайных мет ...
зададзены 20 каст. '09 у 20:33
21
адказ

Які лепшы спосаб рэдагаваць GitHub Readme.md?

Які лепшы спосаб рэдагаваць GitHub Readme.md? Я знаходжу, што рэдагую Readme, затым націскаю яго, бачу памылкі або памылкі фарматавання, зноў рэдагую яго, а затым націскаю на яго ... Гэта сапраўды лік у гісторыі фіксацыі. Ці ёсць прамень ...
зададзены 03 чэрвеня '12 у 19:09
4
адказаў

Якія новыя каманды дакументацыі даступныя ў Xcode 5?

Адной з новых функцый Xcode 5 з'яўляецца магчымасць дакументаваць свой уласны код з адмысловым сінтаксісам каментароў. Фармат падобны на doxygen, але, падобна, падтрымлівае толькі падмноства гэтых функцый. Якія каманды падтрымліваюцца, а ка ...
зададзены 03 каст. '13 а 23:14
8
адказаў

Тэхнічныя парады для напісання выдатнага Javadoc

Якія вашы тэхнічныя парады для напісання выдатнага Javadoc? Я шукаю рэчы, якія выходзяць за рамкі стандартных саветаў па тэме "Тлумачэнне функцыі". Мы ўсё гэта ведаем! (Правільна?) Мне цікавыя такія рэчы: Якія тэгі павінны вызначана быць часткай ...
зададзены 29 снеж. '09 а 23:16
15
адказаў

Стварэнне вялікай дакументацыі API: інструменты і метады

Мне даручана стварыць вэб-сэрвіс, які будзе выкарыстоўвацца некалькімі рознымі распрацоўшчыкамі, якія выкарыстоўваюць розныя платформы, якія працуюць для розных кампаній і якія маюць значна розныя ўзроўні кваліфікацыі. Такім чынам, я хацеў бы стварыць дакум ...
зададзены 04 студз. '10 у 23:11
2
адказаў

pandas дакументацыя па перапраграмаванню

Такім чынам, я цалкам разумею, як выкарыстоўваць resample, але дакументацыя не робіць добрую працу, тлумачачы варыянты. Таму большасць опцый у функцыі resample даволі простыя, за выключэннем наступных двух: правіла: радок зрушэння ці пра ...
зададзены 08 чэрвеня '13 у 19:09