CE TAG EST UNIQUEMENT POUR LES GÉNÉRATEURS DE DOCUMENTS. Incluez également la langue et / ou la balise SDE. NE PAS UTILISER pour demander des liens vers de la documentation ou des outils, ou pour critiquer la documentation du fournisseur.
J'ai récemment commencé à étudier Python , mais je n'ai pas trouvé comment implémenter les commentaires sur plusieurs lignes. La plupart des langues ont des symboles de commentaire de bloc comme /* */ J'ai essayé cela en Python, mais cela génère une erreur, donc ce n'est probablement pas la bonne...
Dans l'Objectif C, je peux utiliser #pragma markpour marquer des sections de mon code dans le navigateur de symboles. Comme il s'agit d'une commande de préprocesseur C, elle n'est pas disponible dans Swift. Y a-t-il un remplaçant pour cela dans Swift, ou dois-je utiliser des commentaires...
Fermé . Cette question est basée sur l'opinion . Il n'accepte pas actuellement de réponses. Voulez-vous améliorer cette question? Mettez à jour la question afin d'y répondre avec des faits et des citations en modifiant ce message . Fermé il y a 2 ans . J'ai vu différents styles d'écriture de...
Dans l'état actuel des choses, cette question ne convient pas à notre format de questions / réponses. Nous nous attendons à ce que les réponses soient étayées par des faits, des références ou une expertise, mais cette question suscitera probablement un débat, des arguments, des sondages ou une...
Lorsque vous écrivez de la documentation xml, vous pouvez l'utiliser <see cref="something">something</see>, ce qui fonctionne bien sûr. Mais comment référencer une classe ou une méthode avec des types génériques? public class FancyClass<T> { public string FancyMethod<K>(T...
Cela devrait être plus facile ... Je veux ajouter un saut de ligne "codé" à la documentation XML dans mon code /// <summary> /// Get a human-readable variant of the SQL WHERE statement of the search element. <br/> /// Rather than return SQL, this method returns a string with...
Je sais que ce n'est pas le problème le plus vital, mais je viens de réaliser que je peux mettre le bloc de commentaires javadoc avant ou après l'annotation. Que voudrions-nous adopter comme norme de codage? /** * This is a javadoc comment before the annotation */ @Component public class MyClass {...
Fermé. Cette question ne respecte pas les directives de Stack Overflow . Il n'accepte pas les réponses actuellement. Vous souhaitez améliorer cette question? Mettez à jour la question pour qu'elle soit pertinente pour Stack Overflow. Fermé il y a 2 ans . Améliorez cette question L'une des...
Je comprends donc parfaitement comment utiliser le rééchantillonnage , mais la documentation ne fait pas un bon travail pour expliquer les options. La plupart des options de la resamplefonction sont donc assez simples, à l'exception de ces deux: règle: la chaîne de décalage ou l'objet représentant...
Fermé . Cette question est basée sur l'opinion . Il n'accepte pas les réponses actuellement. Vous souhaitez améliorer cette question? Mettez à jour la question afin de pouvoir y répondre avec des faits et des citations en éditant ce message . Fermé il y a 2 ans . Améliorez cette question Ok, donc...
Fermé . Cette question est basée sur l'opinion . Il n'accepte pas les réponses actuellement. Vous souhaitez améliorer cette question? Mettez à jour la question afin de pouvoir y répondre avec des faits et des citations en éditant ce message . Fermé il y a 2 ans . Améliorez cette question Je débute...
Comment puis-je informer JSDoc de la structure d'un objet renvoyé. J'ai trouvé la @return {{field1: type, field2: type, ...}} descriptionsyntaxe et l' ai essayé: /** * Returns a coordinate from a given mouse or touch event * @param {TouchEvent|MouseEvent|jQuery.Event} e * A valid mouse or touch...
J'écris actuellement un petit framework qui sera utilisé en interne par d'autres développeurs au sein de l'entreprise. Je souhaite fournir de bonnes informations Intellisense, mais je ne sais pas comment documenter les exceptions levées. Dans l'exemple suivant: public void MyMethod1() {...
Comment documenter des méthodes avec des paramètres en utilisant les chaînes de documentation de Python? EDIT: PEP 257 donne cet exemple: 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...
Fermé. Cette question ne respecte pas les directives de Stack Overflow . Il n'accepte pas les réponses actuellement. Vous souhaitez améliorer cette question? Mettez à jour la question pour qu'elle soit pertinente pour Stack Overflow. Fermé il y a 12 mois . Améliorez cette question J'essaie de...
Fermé . Cette question est basée sur l'opinion . Il n'accepte pas les réponses actuellement. Vous souhaitez améliorer cette question? Mettez à jour la question afin de pouvoir y répondre avec des faits et des citations en éditant ce message . Fermé il y a 6 ans . Améliorez cette question TeX /...
Fermé . Cette question est basée sur l'opinion . Il n'accepte pas les réponses actuellement. Vous souhaitez améliorer cette question? Mettez à jour la question afin de pouvoir y répondre avec des faits et des citations en éditant ce message . Fermé il y a 2 ans . Améliorez cette question J'écris...
Dans JSDoc, la meilleure documentation que je peux trouver montre l'utilisation de ce qui suit si vous avez un tableau d'un type spécifique (tel qu'un tableau de chaînes) comme: /** * @param {Array.<string>} myStrings All my awesome strings */ function blah(myStrings){ //stuff here... }...
Existe-t-il une norme pour interpréter la syntaxe des interfaces de fonction dans les documentations API et si oui, comment est-elle définie? Voici un exemple de modification de la couleur d'un élément dans le guide de script JavaScript de Photoshop pour la fonction "fillColor": fillPath...
La documentation permettant d'activer l'intégration de XmlDoc dans vos projets Web Api semble gérer uniquement les situations où tous vos types d'API font partie de votre projet WebApi. En particulier, il explique comment rediriger la documentation XML vers App_Data/XmlDocument.xmlet décommenter...