Запитання з тегом «documentation»

Нещодавно я почав вивчати Python , але не міг знайти, як реалізувати багаторядкові коментарі. Більшість мов мають символи блоку коментарів, як /* */ Я спробував це в Python, але це видає помилку, тому це, мабуть, не правильний спосіб. Чи дійсно в Python є функція багаторядкових коментарів?

1156 python  comments  documentation 

У Цілі C я можу використовувати #pragma markдля позначення розділів свого коду в навігаторі символів. Оскільки це команда препроцесора C, вона не доступна в Swift. Чи є в цьому тему "Свіфт", або мені потрібно використовувати некрасиві коментарі?

936 swift  documentation 

Закрито . Це питання ґрунтується на думці . Наразі відповіді не приймаються. Хочете вдосконалити це питання? Оновіть питання, щоб на нього можна було відповісти фактами та цитатами, відредагувавши цю публікацію . Закрито 2 роки тому . Я бачив декілька різних стилів написання доктрингів у Python, чи існує офіційний чи «узгоджений» …

887 python  coding-style  documentation  docstring 

Наразі це запитання не підходить для нашого формату запитань. Ми очікуємо, що відповіді будуть підкріплені фактами, посиланнями або експертними знаннями, але це питання, ймовірно, вимагатиме дискусій, аргументів, опитувань чи розширеної дискусії. Якщо ви вважаєте, що це питання можна вдосконалити та, можливо, знову відкрити, відвідайте довідковий центр для ознайомлення . Закрито …

258 documentation  comments 

Зачинено. Це питання не відповідає вказівкам щодо переповнення стека . Наразі відповіді не приймаються. Хочете вдосконалити це питання? Оновіть питання, щоб воно було тематичним для переповнення стека. Закрито 2 роки тому . Удосконаліть це питання Однією з нових можливостей Xcode 5 є можливість документувати власний код за допомогою синтаксису спеціального …

186 objective-c  documentation  comments  doxygen  xcode5 

Тому я повністю розумію, як використовувати resample , але документація не робить гарної роботи з поясненням варіантів. Таким чином, більшість варіантів resampleфункції є досить прямим вперед, за винятком цих двох: правило: рядок зміщення або об'єкт, що представляє цільове перетворення як: рядок, метод для повторного або повторного відбору проб, за замовчуванням …

184 python  documentation  pandas 

Закрито . Це питання ґрунтується на думці . Наразі відповіді не приймаються. Хочете вдосконалити це питання? Оновіть питання, щоб на нього можна було відповісти фактами та цитатами, відредагувавши цю публікацію . Закрито 2 роки тому . Удосконаліть це питання Гаразд, тому я прочитав і PEP 8, і PEP 257 , …

167 python  documentation  module 

Закрито . Це питання ґрунтується на думці . Наразі відповіді не приймаються. Хочете вдосконалити це питання? Оновіть питання, щоб на нього можна було відповісти фактами та цитатами, відредагувавши цю публікацію . Закрито 2 роки тому . Удосконаліть це питання В даний час я починаю з Python, і у мене є …

162 python  documentation  javadoc  docstring 

Наразі я пишу невеликий фреймворк, який буде використовуватися внутрішньо іншими розробниками в компанії. Я хочу надати хорошу інформацію Intellisense, але я не впевнений, як документувати викинуті винятки. У наступному прикладі: public void MyMethod1() { MyMethod2(); // also may throw InvalidOperationException } public void MyMethod2() { System.IO.File.Open(somepath...); // this may throw …

139 c#  .net  documentation  intellisense 

Як документувати методи з параметрами за допомогою рядків документації Python? EDIT: PEP 257 дає такий приклад: def complex(real=0.0, imag=0.0): """Form a complex number. Keyword arguments: real -- the real part (default 0.0) imag -- the imaginary part (default 0.0) """ if imag == 0.0 and real == 0.0: return complex_zero …

139 python  documentation  documentation-generation 

Зачинено. Це питання не відповідає вказівкам щодо переповнення стека . Наразі відповіді не приймаються. Хочете вдосконалити це питання? Оновіть питання, щоб воно було тематичним для переповнення стека. Закрито 12 місяців тому . Удосконаліть це питання Я намагаюся знайти документацію для використання API FFmpeg C. Здається, що доступна лише документація на …

119 c  api  documentation  ffmpeg 

Закрито . Це питання ґрунтується на думці . Наразі відповіді не приймаються. Хочете вдосконалити це питання? Оновіть питання, щоб на нього можна було відповісти фактами та цитатами, відредагувавши цю публікацію . Закрито 6 років тому . Удосконаліть це питання TeX / LaTeX - це чудово, я його використовую багато в …

118 documentation  latex  tex 

Закрито . Це питання ґрунтується на думці . Наразі відповіді не приймаються. Хочете вдосконалити це питання? Оновіть питання, щоб на нього можна було відповісти фактами та цитатами, відредагувавши цю публікацію . Закрито 2 роки тому . Удосконаліть це питання Я пишу легкий клас, атрибути якого призначені для загальнодоступного доступу, і …

115 python  class  documentation  docstring  class-attributes 

У JSDoc найкраща документація, яку я можу знайти, показує використання наступного, якщо у вас є масив конкретного типу (наприклад, масив рядків) як: /** * @param {Array.<string>} myStrings All my awesome strings */ function blah(myStrings){ //stuff here... } Як би ви замінили наведені нижче знаки запитання на вказаний масив об’єктів? /** …

105 javascript  documentation  jsdoc 

Чи існує стандарт інтерпретації синтаксису функціональних інтерфейсів в документації API і якщо так, то як це визначено? Ось приклад того, як змінити колір елемента, керівництво сценарієм JavaScript для Photoshop для функції "fillColor": fillPath ([fillColor] [, mode] [, opacity] [, preserveTransparency] [, feather] [, wholePath] [, antiAlias]) Яке значення дужок і …

103 api  documentation