Most voted "documentation" questions
Documentation is a file or set of files that come with a program that details how programs work.
Learn more…60 questions
Sort by count of
-
21
votes1
answer1658
viewsHow to document SQL code?
When I write R codes, the correct way to document is in the code itself, in the form of comments initiated with a special marking #'. #' Add together two numbers. #' #' @param x A number. #' @param…
-
20
votes1
answer9558
viewsIs there official documentation for Javascript?
Is there any official Javascript documentation like you have PHP.net or jQuery.com? When we search on Google nothing like Javascript appears.com...
-
15
votes2
answers2001
viewsDocumentation in software development
I would like to ask my question on the basis of in that matter on tests. There are different ways to document a software, the ones I’ve noticed the most are: Class documentation (developer comments…
-
13
votes1
answer369
viewsWhat tags can I use to document my code?
I’m looking for better ways to document my code in Netbeans. Besides the tags known and used in Javadoc something caught my attention and aroused my curiosity. When typing {@ some suggestions of…
-
11
votes3
answers13259
viewsHow to develop user manuals?
I came across a situation here that prompted me to look for some software that would allow me to create a well done user manual. What happens is that I was tasked with developing the system user…
-
10
votes2
answers7145
viewsIs it good practice to use <Summary> for documentation?
This is the best way to document code in C#? /// <summary> /// Descrição /// </summary>
-
10
votes2
answers124
viewsHow to read the Git help manual?
I’m trying to learn more about Git and I’m bumping into a basic question, I don’t know how to read the manual. I understand some things, but I’m not sure yet what the symbols are used for: [],…
-
10
votes1
answer169
viewsWhat is formal documentation?
On the website of W3schools they mention the expression "formal documentation". It is Most common to use single line comments. Block comments are often used for formal Documentation. What is a…
-
9
votes1
answer4824
viewsJavascript code documentation standard and automatic documentation generation on Ides and exportable
Java has the Javadoc, PHP has Phpdoc and other languages, has documentation standards. Which standard most used to document javascript, already integrated with Ides, so that when using functions, it…
-
9
votes1
answer260
viewsDocumentation in XML
I develop a framework in PHP and would not like to comment on the code of the framework directly in the classes, for several reasons. So I wonder if there is an editor that reads the documentation…
-
9
votes2
answers132
viewsHow to correctly read documentation from an SQL command?
I was studying the concept of transactions and as always the reference was the documentation of Microsoft itself (in the case for the products of the same). In the link below there is the…
-
8
votes3
answers403
viewsAgile development and documentation update
Taking into account the second premise of the agile manifesto: “Software in operation more than comprehensive documentation" According to the agile practices, Scrum, XP, etc..., if during…
-
6
votes1
answer130
viewsHow to document in code a hack, Hotfix and any potentially problematic outline situation
Hacks, emergency fixes and any potentially problematic contouring situation are a necessary evil. Although it can be considered personal opinion, when working in a team, a minimum of care is assumed…
-
6
votes1
answer118
viewsIn Devtools is there any way to capture the entire screen of the site, even if it has scroll?
I’m not looking for Chorme extension or screenshot code etc. I just want to know if this developer tool has some native option of this type. I know if you open the DevTools chrome and press…
-
5
votes2
answers1118
viewsOptions to generate javascript library documentation
Currently I have used much the jsdoc3 with the docstrap, however requires a large amount of third party libraries to generate documentation with node and grunt, someone knows a robust alternative…
-
5
votes2
answers203
viewsDocumentation on WPF with pure C# code
WPF is what’s "new" for development, not only desktop but also mobile. However, almost all material that is available on WPF is fully tied to the use of IDE and XAML. But XAML is an intermediate…
-
5
votes2
answers5470
viewsHow is good documentation done using SCRUM?
I am developing documentation using the agile method SCRUM, I do not know if I am on the right track, and many people have difficulty in this, so I decided to realize such a question, currently put…
-
5
votes1
answer135
viewsWhat is UML? What is it for?
A conceptual issue. What is UML? What good is? Is it really useful? Therefore, we must learn? Is widely adopted? What defects of this language? Is linked with object orientation?…
software-engineering uml software-project documentation project-managementasked 3 years, 1 month ago Maniero 444,682 -
4
votes4
answers228
viewsRead XML documentation generated by Visual Studio
How can I read the XML documentation generated by Visual Studio in any way that is formatted?
-
4
votes1
answer4728
viewsHow to transform source code into digital hash summary?
For registration of a software, it is requested: Perform the transformation of the technical documentation (source code) into digital hash summary; the INPI documentation also states: [...]The hash…
-
4
votes1
answer214
viewsHow to document CSS?
I was documenting the typescript of my Angular project using Jsdoc basing myself in this question, and I was left with the following doubt. How can I document my CSS classes and components of my…
-
3
votes0
answers582
viewsIs there a tool that manages documentation similar to MSDN?
Is there a program that transforms the documentation of my code (I can generate .xml) into MSDN-style pages? Or a wiki format?
-
3
votes1
answer256
viewsIs it possible to leave the <Summary> in English?
It is possible to leave in Portuguese the tips of <summary> methods existing in . NET or third-party components in Visual Studio?
-
3
votes1
answer45
viewsRuby doubt Apis
I was reading in the ruby documentation on link about the default ruby classes, but I saw that it has more classes than the documentation shows how to yaml, where can I find those Apis? I want to…
-
3
votes0
answers98
viewsDocumentation for a system
I’m in the middle of producing a web system, actually almost at the end... The point is that no documentation was developed for the system, it was all being developed "directly", based on another…
documentationasked 8 years, 1 month ago Raylan Soares 2,315 -
3
votes2
answers1740
viewsQuery methods, classes and attributes in the C language
I wondered if in the C language and possible query libraries available their modules classes and attributes as in the Python language that exist the methods dir() and help() i am starting to learn C…
-
3
votes0
answers327
viewsHow to efficiently convert static/binary files (images, Pdfs, etc.)?
For example I have a PDF file with a content and after modifying some things in it, how should I proceed in question of the versions? (For some reason I should review this file). And in the case of…
-
3
votes1
answer292
viewsWhere can I find the reference for defining dates of the dd/mm/yyyy format?
I’m doing the documentation of an API, but I don’t know where I can find what defines the date in the Brazilian, Italian, etc., formatting styles dd/mm/yyyy. Dates in format yyyy-mm-dd are defined…
-
3
votes2
answers73
viewsIs there documentation in the Ecmascript standard that ensures that an array when passed as a property advisor has a defined format?
The other day debugging a code here on the page I found something peculiar. Like that: let a = {}; let b = [1,2,3]; let c = [4,2,3]; a[b]= 1; a[c]= 2; console.log(a) //{ "1,2,3": 1, "4,2,3": 2 }…
javascript characteristic-language software-engineering documentation ecmascriptasked 3 years, 1 month ago Augusto Vasques 15,321 -
2
votes2
answers275
viewsEditing of captured fabrics for making manuals
[Note: goal: I know it’s not about programming, but I’m not sure about the limits of Stack Overflow PT yet, so it’s also a test for our site.] At the end of the software development, it was time to…
documentationasked 10 years, 4 months ago woliveirajr 2,122 -
2
votes1
answer167
viewsWas the use_include_path parameter replaced by the flags parameter?
I always use the English documentation of PHP, because it seems to me that it is always more up to date, but when accessing the documentation of file_get_contents in Portuguese, I noticed the…
-
2
votes1
answer73
viewsSummary in classes and methods
How important the use of <summary> in methods and classes? How impactful this is at the level of development? Which is the good side and which is the bad side of its use?…
-
2
votes1
answer106
viewsJava class version
I wonder if in java I can specify a tag, or manifest, or something like that for a class or library and be able to query it within the Java code itself guy : @version 2.6.5 Class Pessoa { ... } and…
-
2
votes1
answer1486
viewsPHP - Add watermark to a DOC or PDF
I need you to take my document . doc or . pdf and add a watermark D`, it can also be the mark "DRAFT" when viewing. The BO is as follows, need to view a document but need to have something…
-
2
votes0
answers101
viewsDocumentation framework for java REST API
Hello, I have a java project, with REST Apis. I wanted to create a documentation wiki (markdown+Swagger) on Apis locally, including also a way to test the API (console API/explorer). These are…
-
2
votes2
answers64
viewsInherit comments from a virtual object
How can I inherit the comments within the tag <summary> of an object? I have the following class: class BASE { /// <summary> /// String de Conexão a base de dados. /// </summary>…
-
2
votes1
answer130
viewsThere is a standard documentation/software comments in Reactjs
I’m leading a development team on Reactjs with Node.Js, and I’m having a question about how to document or comment this code so it’s nice and easy to read by other devs. Still commenting code? Sorry…
-
1
votes0
answers205
viewsDocumentation of software developed
The file must contain: Explanation of the BD with Model ER Explanation of the Interface, Explanation of property files Use Case Diagram Creation (or other such that exemplifies all software progress…
-
1
votes1
answer61
viewsSystem documentation in conversion
I am in the process of converting a system in Delphi to C# using the SCRUM methodology, until then there is no documentation of this system. So I would like to know what they indicate, I don’t need…
-
1
votes1
answer65
viewsGenerate merge and branch charts in GIT?
I would like a tool to document my activities in GIT, which generates a flow chart like this: What tool would generate a documentation of merges, branches, tags, releasses in GIT, i.e., documenting…
-
1
votes1
answer318
viewsWhat does it take to learn specific classes and methods for a task?
What I need to learn about classes and methods in general for Java and Android programming? For example: if I need to display a PDF, as I’ll learn to do it? We know that there are several classes,…
-
1
votes1
answer1069
viewsDifference between "Extension Relationship" and "Extension Point"
Good morning! What is the difference between these two terms and their use in the use case diagram? I already know the concept of extension, but I didn’t understand the relationship between the two.…
-
1
votes2
answers1382
viewsOptions to generate API documentation in Laravel
I need a lib to generate API documentation in Laravel 5.4?
-
1
votes0
answers319
viewsDocumentation in C#
I would like to document an api for C#, in the style javadoc. Is there any way to memorize/comment the code so that documentation of the types and their members is generated automatically? C# gives…
-
1
votes2
answers111
viewsWhy doesn’t a private method go into the documentation in Java?
Why when a method has one void as modifier it does not appear in the documentation? As soon as I put the public it appeared in the documentation. Is there any other modifier that interferes with…
-
1
votes0
answers51
viewsAre "help", "terms and policies" functional or non-functional requirements?
My question is exactly this if the help is a functional requirement or not in a system, since it after being clicked brings a would strings and formatting.
-
1
votes0
answers33
viewsDocument code snippets and annotations
I wonder if anyone knows any tool for documenting snippets and annotations of code separated by a tree or topics (Technologies for example) referring? I’d like something like https://devdocs.io/ but…
-
0
votes1
answer564
viewsComposer error while downloading phpdoc
Operating System: Ubuntu 14.04 PHP 5.3.10 Curl 7.22.0 I am trying to download phpdocumentor 2.0.0. But it gives this error: Your requirements could not be resolved to an installable set of packages.…
-
0
votes1
answer67
viewsError Running Phpdoc in Ubuntu
After downloading phpdoc by Composer.phar What happened successfully. I try to execute: ~$ ./phpdoc In Terminal and get the following error message: ubuntualex@ubuntualex-VirtualBox:~/vendor/bin$…
-
0
votes1
answer634
viewsMethodology and Documentation for ASP.NET MVC Projects
In the company where I work I have always been free to develop the requested applications. I always worked in a unique way despite having a co-worker because, we both developed separate projects.…