Questa è una domanda che ho originariamente chiesto su Stack Overflow, ma come domanda di progettazione concettuale e non tecnica, credo che potrebbe essere più appropriato, o possibilmente avere un valore parallelo alternativo, su questa scheda. / em>
La struttura di un programma FiM ++ richiede che termini con la chiusura di una lettera e il nome dell'autore del codice in un modo specifico.
Dear Princess Celestia and Stack Exchange and String: A Sample:
...
Your faithful student, Southpaw Hare!
In base alla specifica della lingua , la parola chiave " Your faithful student, "(compresa la virgola e lo spazio seguente) viene utilizzato come tag di chiusura per le definizioni di classe e il nome seguente è un commento senza effetto sintattico.
Il fatto che l'autore sia incluso automaticamente (se non strettamente richiesto) in ogni file mi fa chiedere se possa essere usato come una forma di documentazione interpretabile simile a Java Docs. In altre parole, altri programmi o editor potrebbero essere in grado di analizzare questo nome e usarlo in qualche modo.
-
Qual è il requisito di tale documentazione interna basata sui commenti? C'è qualcosa in questo particolare tipo di sintassi che potrebbe causare problemi?
-
La parola chiave è sufficiente per adattarsi al tema? Mi viene in mente che la mancanza di capacità di usare "I tuoi fedeli studenti", per una forma plurale (o forse "Distinti fedeli", o "Cordiali saluti", per una versione ambigua) farebbe elencare più autori sgradevoli e innaturali ( e apparire come una naturale lettera scritta da umani è uno dei paradigmi principali del design).
-
Se è stata presa in considerazione la creazione di una metodologia di Java Docs, quali altre funzionalità dovrebbero essere incluse? Per uno, una data sembra comune. Includere qualche forma di commento di data nella parte superiore della lettera sarebbe probabilmente naturale e non sfidare il paradigma del design.
Poiché la lingua è nuova, sconosciuta ai più, e onestamente abbastanza sciocca, ecco alcune risorse da considerare: