Documenter son code en RDF

Posté en august 2008

Entre autres suggestions, je vais réfléchir à ça mais c'est vrai qu'il pourrait être intéressant d'avoir des convention style Turtle qui pourraient ensuite être exploitées par les IDE (tout en restant lisible). Ou lorsque le Web Sémantique sort du web.

5 Commentaires

Déjà que j'ai de la peine avec les doc de type javadoc, reste éloigné de la version XML concoctée par Microsoft alors l'idée d'utiliser RDF directement me rend un peu sceptique.

Il pourrait être en revanche intéressant de créer une base de triples à partir de documentation existante, ReST-like ou JavaDoc-like. Ça signifierait une véritable recherche multi-facettes et plus le traditionnel et si ennuyeux jeu de cadres : modules, classes/fonctions, détail.

De mon point de vue, une solution qui nécessite un IDE pour s'en servir n'est pas une solution vers laquelle je me tournerai.

1 | Yoan, le 24 August 2008 à 10h

"Il pourrait être en revanche intéressant de créer une base de triples à partir de documentation existante, ReST-like"

C'est quoi une documentation ReST-like ?

2 | Damien B, le 24 August 2008 à 14h

@Yoan : je ne souhaite justement pas qu'une IDE soit nécessaire (d'où le "tout en restant lisible"), l'IDE permettrait juste d'exploiter à fond les possibilités offertes par RDF, style pouvoir passer une requête SPARQL sur tous les commentaires d'un code : donne moi toutes les fonctions qui ont un email en entrée et qui me retournent une liste de personnes, etc.

J'évoquais turtle car c'est l'une des syntaxes les plus simples pour écrire du RDF à mon avis, il y a ntriples aussi : http://www.w3.org/TR/rdf-testcases/#ntriples il y a un joli graphe qui résume ça sur la page de notation 3 : http://www.w3.org/DesignIssues/Notation3

@Damien B.: il s'agit de http://docutils.sourceforge.net/rst.html

3 | David, biologeek, le 25 August 2008 à 09h

Ha, reST, pas ReST. Courage, encore quelques heures de réflexion, et on va nous ressortir CWEB.

4 | Damien B, le 25 August 2008 à 13h

Ajouter un commentaire

Billets ★ choisis

★ Bien débuter avec Django : le framework web python pour les perfectionnistes pressés

Logo associé au billet intitulé Bien débuter avec Django : le framework web python pour les perfectionnistes pressés

Vous êtes maintenant convaincu qu'un framework web va vous permettre d'optimiser votre temps de développement et votre choix de framework s'est naturellement porté sur django, notamment car il est écrit en python et qu'il est proche ...

★ Pourquoi avoir peur de Google ?

Logo associé au billet intitulé Pourquoi avoir peur de Google ?

J'en ai pris plein la tête dans les 20 premiers commentaires de ma dernière brève sur Google Chrome mais je reste tout de même sur mes positions. Je vais essayer d'expliquer pourquoi plus en détail, sans tomber dans ...

★ L'architecture orientée ressource pour faire des services web RESTful

Le plus gros défaut de REST, c'est sûrement de se limiter à la comparaison des 4 verbes HTTP (GET, POST, PUT et DELETE) aux 4 actions possibles sur des données issues de bases de données (Retrieve, Create, Update et ...

© 2004-2008 David Larlet - Licence (presque) libre - Site enfin propulsé par Django et hébergé par Typhon.